Java Doc for LHUploadFacesPortlet.java in  » Portal » Open-Portal » com » sun » portal » app » filesharing » faces » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Use the UploadFilter if your application contains an Upload component (<ui:upload> tag).

Configure the filter by declaring the filter element in the web application's deployment descriptor.

 <filter>
 <filter-name>UploadFilter</filter-name>
 <filter-class>com.sun.web.ui.util.UploadFilter</filter-class>
 </filter>
 

Map the filter to the FacesServlet, for example

 <filter-mapping>
 <filter-name>UploadFilter</filter-name>
 <servlet-name>FacesServlet</servlet-name>
 </filter-mapping>
 

The UploadFilter uses the Apache commons fileupload package. You can configure the parameters of the DiskFileUpload class by specifying init parameters to the Filter. The following parameters are available:

• maxSize The maximum allowed upload size in bytes. If negative, there is no maximum. The default value is 1,000,000.
• sizeThresholdThe implementation of the uploading functionality uses temporary storage of the file contents before the Upload component stores them per its configuration. In the temporary storage, smaller files are stored in memory while larger files are written directly to disk . Use this parameter to specify an integer value of the cut-off where files should be written to disk. The default value is 4096 bytes.
• tmpDir Use this directory to specify the directory to be used for temporary storage of files. The default behaviour is to use the directory specified in the system property "java.io.tmpdir".

The upload filter checks if the incoming request has multipart content. If it doesn't, the request is passed on as is to the next filter in the chain. If it does, the filter processes the request for form components.

The upload filter checks if the incoming request has multipart content. If it doesn't, the request is passed on as is to the next filter in the chain. If it does, the filter processes the request for form components. If it finds input from an Upload component, the file contents are stored for access by the Upload component's decode method.

For other form components, the input is processed and used to create a request parameter map. The original incoming request is wrapped, and the wrapped request is configured to use the created map. This means that subsequent filters in the chain (and Servlets, and JSPs) see the input from the other components as request parameters.

For advanced users: the UploadFilter uses the Apache commons FileUpload package to process the file upload. When it detects input from an Upload component, a org.apache.commons.fileupload.FileItem is placed in a request attribute whose name is the ID of the HTML input element written by the Upload component.