Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.apache.commons.fileupload.portlet;
 
 import java.util.List;
 import java.util.Map;
 
 import  javax.portlet.ActionRequest;
 

High level API for processing file uploads.

This class handles multiple files per single HTML widget, sent using multipart/mixed encoding type, as specified by RFC 1867. Use .parseRequest(javax.servlet.http.HttpServletRequest) to acquire a list of FileItems associated with a given HTML widget.

How the data for individual parts is stored is determined by the factory used to create them; a given part may be in memory, on disk, or somewhere else.

Version:
$Id: PortletFileUpload.java 1455537 2013-03-12 14:06:11Z simonetripodi $
Since:
FileUpload 1.1
 
 public class PortletFileUpload extends FileUpload {
 
     // ---------------------------------------------------------- Class methods
 
    
Utility method that determines whether the request contains multipart content.

Parameters:
request The portlet request to be evaluated. Must be non-null.
Returns:
true if the request is multipart; false otherwise.
 
     public static final boolean isMultipartContent(ActionRequest request) {
         return FileUploadBase.isMultipartContent(
                 new PortletRequestContext(request));
     }
 
     // ----------------------------------------------------------- Constructors
 
    
Constructs an uninitialised instance of this class. A factory must be configured, using setFileItemFactory(), before attempting to parse requests.

See also:
FileUpload.FileUpload(FileItemFactory)
 
     public PortletFileUpload() {
         super();
     }

    
Constructs an instance of this class which uses the supplied factory to create FileItem instances.

Parameters:
fileItemFactory The factory to use for creating file items.
See also:
FileUpload.FileUpload()
 
     public PortletFileUpload(FileItemFactory fileItemFactory) {
         super(fileItemFactory);
     }
 
     // --------------------------------------------------------- Public methods
 
    
Processes an RFC 1867 compliant multipart/form-data stream.

Parameters:
request The portlet request to be parsed.
Returns:
A list of FileItem instances parsed from the request, in the order that they were transmitted.
Throws:
FileUploadException if there are problems reading/parsing the request or storing files.
    public List<FileItemparseRequest(ActionRequest request)
            throws FileUploadException {
        return parseRequest(new PortletRequestContext(request));
    }

    
Processes an RFC 1867 compliant multipart/form-data stream.

Parameters:
request The portlet request to be parsed.
Returns:
A map of FileItem instances parsed from the request.
Throws:
FileUploadException if there are problems reading/parsing the request or storing files.
Since:
1.3
    public Map<StringList<FileItem>> parseParameterMap(ActionRequest request)
            throws FileUploadException {
        return parseParameterMap(new PortletRequestContext(request));
    }

    
Processes an RFC 1867 compliant multipart/form-data stream.

Parameters:
request The portlet request to be parsed.
Returns:
An iterator to instances of FileItemStream parsed from the request, in the order that they were transmitted.
Throws:
FileUploadException if there are problems reading/parsing the request or storing files.
IOException An I/O error occurred. This may be a network error while communicating with the client or a problem while storing the uploaded content.
    public FileItemIterator getItemIterator(ActionRequest request)
            throws FileUploadExceptionIOException {
        return super.getItemIterator(new PortletRequestContext(request));
    }
New to GrepCode? Check out our FAQ X