FileItem (Apache Commons FileUpload 1.3.3 API)

; Tue, 13 Jun 2017 12:48:44 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1013974 [4/43] - in /websites/production/commons/content/proper/commons-fileupload/javadocs: ./ api-release/ api-release/org/ api-release/org/apache/ api-release/org/apache/commons/ api-release/org/apache/commons/fileupload/ api-release/or... Date: Tue, 13 Jun 2017 12:48:40 -0000 To: notifications@commons.apache.org From: chtompki@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20170613124844.81DE13A259F@svn01-us-west.apache.org> archived-at: Tue, 13 Jun 2017 12:48:52 -0000 Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItem.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItem.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItem.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,607 @@ + + + + + + +FileItem (Apache Commons FileUpload 1.3.3 API) + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

+
+
All Superinterfaces:
+
FileItemHeadersSupport, Serializable
+
+
+
All Known Implementing Classes:
+
DefaultFileItem, DiskFileItem
+
+
+
+
```
public interface FileItem
+extends Serializable, FileItemHeadersSupport
```
+
This class represents a file or form item that was received within a + multipart/form-data POST request. + +
After retrieving an instance of this class from a FileUpload instance (see + #parseRequest(javax.servlet.http.HttpServletRequest)), you may + either request all contents of the file at once using get() or + request an InputStream with + getInputStream() and process the file without attempting to load + it into memory, which may come handy with large files. + +
While this interface does not extend + javax.activation.DataSource per se (to avoid a seldom used + dependency), several of the defined methods are specifically defined with + the same signatures as methods in that interface. This allows an + implementation of this interface to also implement + javax.activation.DataSource with minimal additional work.
+
+
Since:
+
1.3 additionally implements FileItemHeadersSupport
+
Version:
+
$Id$
+
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`delete()` + Deletes the underlying storage for a file item, including deleting any + associated temporary disk file. +
`byte[]`	`get()` + Returns the contents of the file item as an array of bytes. +
`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. +
`InputStream`	`getInputStream()` + Returns an `InputStream` that can be + used to retrieve the contents of the file. +
`String`	`getName()` + Returns the original filename in the client's filesystem, as provided by + the browser (or other client software). +
`OutputStream`	`getOutputStream()` + Returns an `OutputStream` that can + be used for storing the contents of the file. +
`long`	`getSize()` + Returns the size of the file item. +
`String`	`getString()` + Returns the contents of the file item as a String, using the default + character encoding. +
`String`	`getString(String encoding)` + Returns the contents of the file item as a String, using the specified + encoding. +
`boolean`	`isFormField()` + Determines whether or not a `FileItem` instance represents + a simple form field. +
`boolean`	`isInMemory()` + Provides a hint as to whether or not the file contents will be read + from memory. +
`void`	`setFieldName(String name)` + Sets the field name used to reference this file item. +
`void`	`setFormField(boolean state)` + Specifies whether or not a `FileItem` instance represents + a simple form field. +
`void`	`write(File file)` + A convenience method to write an uploaded item to disk. +

+ + +
Methods inherited from interface org.apache.commons.fileupload.FileItemHeadersSupport
+getHeaders, setHeaders

+ +
- + + +
  Method Detail
  + + + +
  - +
    getInputStream
    +
```
InputStream getInputStream()
+                    throws IOException
```
    +
    Returns an InputStream that can be + used to retrieve the contents of the file.
    +
    +
    Returns:
    +
    An InputStream that can be + used to retrieve the contents of the file.
    +
    Throws:
    +
    IOException - if an error occurs.
    +
    +
  + + + +
  - +
    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().
    +
    +
  + + + +
  - +
    isInMemory
    +
```
boolean isInMemory()
```
    +
    Provides a hint as to whether or not the file contents will be read + from memory.
    +
    +
    Returns:
    +
    true if the file contents will be read from memory; + false otherwise.
    +
    +
  + + + +
  - +
    getSize
    +
```
long getSize()
```
    +
    Returns the size of the file item.
    +
    +
    Returns:
    +
    The size of the file item, in bytes.
    +
    +
  + + + +
  - +
    get
    +
```
byte[] get()
```
    +
    Returns the contents of the file item as an array of bytes.
    +
    +
    Returns:
    +
    The contents of the file item as an array of bytes.
    +
    +
  + + + +
  - +
    getString
    +
```
String getString(String encoding)
+          throws UnsupportedEncodingException
```
    +
    Returns the contents of the file item as a String, using the specified + encoding. This method uses get() to retrieve the + contents of the item.
    +
    +
    Parameters:
    +
    encoding - The character encoding to use.
    +
    Returns:
    +
    The contents of the item, as a string.
    +
    Throws:
    +
    UnsupportedEncodingException - if the requested character + encoding is not available.
    +
    +
  + + + +
  - +
    getString
    +
```
String getString()
```
    +
    Returns the contents of the file item as a String, using the default + character encoding. This method uses get() to retrieve the + contents of the item.
    +
    +
    Returns:
    +
    The contents of the item, as a string.
    +
    +
  + + + +
  - +
    write
    +
```
void write(File file)
+    throws Exception
```
    +
    A convenience method to write an uploaded item to disk. The client code + is not concerned with whether or not the item is stored in memory, or on + disk in a temporary location. They just want to write the uploaded item + to a file. +
    + This method is not guaranteed to succeed if called more than once for + the same item. This allows a particular implementation to use, for + example, file renaming, where possible, rather than copying all of the + underlying data, thus gaining a significant performance benefit.
    +
    +
    Parameters:
    +
    file - The File into which the uploaded item should + be stored.
    +
    Throws:
    +
    Exception - if an error occurs.
    +
    +
  + + + +
  - +
    delete
    +
```
void delete()
```
    +
    Deletes the underlying storage for a file item, including deleting any + associated temporary disk file. Although this storage will be deleted + automatically when the FileItem instance is garbage + collected, this method can be used to ensure that this is done at an + earlier time, thus preserving system resources.
    +
  + + + +
  - +
    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.
    +
    +
  + + + +
  - +
    setFieldName
    +
```
void setFieldName(String name)
```
    +
    Sets the field name used to reference this file item.
    +
    +
    Parameters:
    +
    name - 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.
    +
    +
  + + + +
  - +
    setFormField
    +
```
void setFormField(boolean state)
```
    +
    Specifies whether or not a FileItem instance represents + a simple form field.
    +
    +
    Parameters:
    +
    state - true if the instance represents a simple form + field; false if it represents an uploaded file.
    +
    +
  + + + +
  - +
    getOutputStream
    +
```
OutputStream getOutputStream()
+                      throws IOException
```
    +
    Returns an OutputStream that can + be used for storing the contents of the file.
    +
    +
    Returns:
    +
    An OutputStream that can be used + for storing the contensts of the file.
    +
    Throws:
    +
    IOException - if an error occurs.
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

+ + Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItemFactory.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItemFactory.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItemFactory.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,255 @@ + + + + + + +FileItemFactory (Apache Commons FileUpload 1.3.3 API) + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

+
+
All Known Implementing Classes:
+
DefaultFileItemFactory, DiskFileItemFactory
+
+
+
+
```
public interface FileItemFactory
```
+
A factory interface for creating FileItem instances. Factories + can provide their own custom configuration, over and above that provided + by the default file upload implementation.
+
+
Version:
+
$Id$
+
+

+ +

+ + +

Method Summary

+ + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`FileItem`	`createItem(String fieldName, + String contentType, + boolean isFormField, + String fileName)` + Create a new `FileItem` instance from the supplied parameters and + any local factory configuration. +

+ +
- + + +
  Method Detail
  + + + +
  - +
    createItem
    +
```
FileItem createItem(String fieldName,
+                    String contentType,
+                    boolean isFormField,
+                    String fileName)
```
    +
    Create a new FileItem instance from the supplied parameters and + any local factory configuration.
    +
    +
    Parameters:
    +
    fieldName - The name of the form field.
    +
    contentType - The content type of the form field.
    +
    isFormField - true if this is a plain form field; + false otherwise.
    +
    fileName - The name of the uploaded file, if any, as supplied + by the browser or other client.
    +
    Returns:
    +
    The newly created file item.
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

+ + Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItemHeaders.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItemHeaders.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItemHeaders.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,310 @@ + + + + + + +FileItemHeaders (Apache Commons FileUpload 1.3.3 API) + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

+
+
All Known Implementing Classes:
+
FileItemHeadersImpl
+
+
+
+
```
public interface FileItemHeaders
```
+
This class provides support for accessing the headers for a file or form + item that was received within a multipart/form-data POST + request.
+
+
Since:
+
1.2.1
+
Version:
+
$Id$
+
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getHeader(String name)` + Returns the value of the specified part header as a `String`. +
`Iterator<String>`	`getHeaderNames()` + + Returns an `Iterator` of all the header names. +
`Iterator<String>`	`getHeaders(String name)` + + Returns all the values of the specified item header as an + `Iterator` of `String` objects. +

+ +
- + + +
  Method Detail
  + + + +
  - +
    getHeader
    +
```
String getHeader(String name)
```
    +
    Returns the value of the specified part header as a String. + + If the part did not include a header of the specified name, this method + return null. If there are multiple headers with the same + name, this method returns the first header in the item. The header + name is case insensitive.
    +
    +
    Parameters:
    +
    name - a String specifying the header name
    +
    Returns:
    +
    a String containing the value of the requested + header, or null if the item does not have a header + of that name
    +
    +
  + + + +
  - +
    getHeaders
    +
```
Iterator<String> getHeaders(String name)
```
    +
    + Returns all the values of the specified item header as an + Iterator of String objects. +
    +
    + If the item did not include any headers of the specified name, this + method returns an empty Iterator. The header name is + case insensitive. +
    +
    +
    Parameters:
    +
    name - a String specifying the header name
    +
    Returns:
    +
    an Iterator containing the values of the + requested header. If the item does not have any headers of + that name, return an empty Iterator
    +
    +
  + + + +
  - +
    getHeaderNames
    +
```
Iterator<String> getHeaderNames()
```
    +
    + Returns an Iterator of all the header names. +
    +
    +
    Returns:
    +
    an Iterator containing all of the names of + headers provided with this file item. If the item does not have + any headers return an empty Iterator
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

+ + Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItemHeadersSupport.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItemHeadersSupport.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItemHeadersSupport.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,272 @@ + + + + + + +FileItemHeadersSupport (Apache Commons FileUpload 1.3.3 API) + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

+
+
All Known Subinterfaces:
+
FileItem, FileItemStream
+
+
+
All Known Implementing Classes:
+
DefaultFileItem, DiskFileItem
+
+
+
+
```
public interface FileItemHeadersSupport
```
+
Interface that will indicate that FileItem or FileItemStream + implementations will accept the headers read for the item.
+
+
Since:
+
1.2.1
+
Version:
+
$Id$
+
See Also:
+
FileItem, +FileItemStream
+
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`FileItemHeaders`	`getHeaders()` + Returns the collection of headers defined locally within this item. +
`void`	`setHeaders(FileItemHeaders headers)` + Sets the headers read from within an item. +

+ +
- + + +
  Method Detail
  + + + +
  - +
    getHeaders
    +
```
FileItemHeaders getHeaders()
```
    +
    Returns the collection of headers defined locally within this item.
    +
    +
    Returns:
    +
    the FileItemHeaders present for this item.
    +
    +
  + + + +
  - +
    setHeaders
    +
```
void setHeaders(FileItemHeaders headers)
```
    +
    Sets the headers read from within an item. Implementations of + FileItem or FileItemStream should implement this + interface to be able to get the raw headers found within the item + header block.
    +
    +
    Parameters:
    +
    headers - the instance that holds onto the headers + for this instance.
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

+ + Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItemIterator.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItemIterator.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/org/apache/commons/fileupload/FileItemIterator.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,273 @@ + + + + + + +FileItemIterator (Apache Commons FileUpload 1.3.3 API) + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

+
+
+
```
public interface FileItemIterator
```
+
An iterator, as returned by + FileUploadBase.getItemIterator(RequestContext).
+
+
Version:
+
$Id$
+
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`hasNext()` + Returns, whether another instance of `FileItemStream` + is available. +
`FileItemStream`	`next()` + Returns the next available `FileItemStream`. +

+ +
- + + +
  Method Detail
  + + + +
  - +
    hasNext
    +
```
boolean hasNext()
+         throws FileUploadException,
+                IOException
```
    +
    Returns, whether another instance of FileItemStream + is available.
    +
    +
    Returns:
    +
    True, if one or more additional file items + are available, otherwise false.
    +
    Throws:
    +
    FileUploadException - Parsing or processing the + file item failed.
    +
    IOException - Reading the file item failed.
    +
    +
  + + + +
  - +
    next
    +
```
FileItemStream next()
+             throws FileUploadException,
+                    IOException
```
    +
    Returns the next available FileItemStream.
    +
    +
    Returns:
    +
    FileItemStream instance, which provides + access to the next file item.
    +
    Throws:
    +
    NoSuchElementException - No more items are available. Use + hasNext() to prevent this exception.
    +
    FileUploadException - Parsing or processing the + file item failed.
    +
    IOException - Reading the file item failed.
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

Interface FileItem

Method Summary

Methods inherited from interface org.apache.commons.fileupload.FileItemHeadersSupport

Method Detail

getInputStream

getContentType

getName

isInMemory

getSize

get

getString

getString

write

delete

getFieldName

setFieldName

isFormField

setFormField

getOutputStream

Interface FileItemFactory

Method Summary

Method Detail

createItem

Interface FileItemHeaders

Method Summary

Method Detail

getHeader

getHeaders

getHeaderNames

Interface FileItemHeadersSupport

Method Summary

Method Detail

getHeaders

setHeaders

Interface FileItemIterator

Method Summary

Method Detail

hasNext

next