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 {@link
- * #parseRequest(javax.servlet.http.HttpServletRequest)} to acquire a list
- * of {@link com.fr.third.org.apache.commons.fileupload.FileItem 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.
- * - * @author Rafal Krzewski - * @author Daniel Rall - * @author Jason van Zyl - * @author John McNally - * @author Martin Cooper - * @author Sean C. Sullivan - * - * @since FileUpload 1.1 - * - * @version $Id$ - */ -public class PortletFileUpload extends FileUpload { - - // ---------------------------------------------------------- Class methods - - - /** - * Utility method that determines whether the request contains multipart - * content. - * - * @param request The portlet request to be evaluated. Must be non-null. - * - * @returntrue 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 FileUpload#FileUpload(FileItemFactory)
- */
- public PortletFileUpload() {
- super();
- }
-
-
- /**
- * Constructs an instance of this class which uses the supplied factory to
- * create FileItem instances.
- *
- * @see FileUpload#FileUpload()
- * @param fileItemFactory The factory to use for creating file items.
- */
- public PortletFileUpload(FileItemFactory fileItemFactory) {
- super(fileItemFactory);
- }
-
-
- // --------------------------------------------------------- Public methods
-
-
- /**
- * Processes an RFC 1867
- * compliant multipart/form-data stream.
- *
- * @param request The portlet request to be parsed.
- *
- * @return 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 /* FileItem */ parseRequest(ActionRequest request)
- throws FileUploadException {
- return parseRequest(new PortletRequestContext(request));
- }
-
- /**
- * Processes an RFC 1867
- * compliant multipart/form-data stream.
- *
- * @param request The portlet request to be parsed.
- *
- * @return 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.
- * @throws 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 FileUploadException, IOException {
- return super.getItemIterator(new PortletRequestContext(request));
- }
-}
diff --git a/fine-commons-fileupload/src/com/fr/third/org/apache/commons/fileupload/portlet/PortletRequestContext.java b/fine-commons-fileupload/src/com/fr/third/org/apache/commons/fileupload/portlet/PortletRequestContext.java
deleted file mode 100755
index d4cfd0a4e..000000000
--- a/fine-commons-fileupload/src/com/fr/third/org/apache/commons/fileupload/portlet/PortletRequestContext.java
+++ /dev/null
@@ -1,108 +0,0 @@
-/*
- * 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 com.fr.third.org.apache.commons.fileupload.portlet;
-
-import java.io.InputStream;
-import java.io.IOException;
-import javax.portlet.ActionRequest;
-import com.fr.third.org.apache.commons.fileupload.RequestContext;
-
-/**
- * Provides access to the request information needed for a request made to - * a portlet.
- * - * @author Martin Cooper - * - * @since FileUpload 1.1 - * - * @version $Id$ - */ -public class PortletRequestContext implements RequestContext { - - // ----------------------------------------------------- Instance Variables - - /** - * The request for which the context is being provided. - */ - private ActionRequest request; - - - // ----------------------------------------------------------- Constructors - - /** - * Construct a context for this request. - * - * @param request The request to which this context applies. - */ - public PortletRequestContext(ActionRequest request) { - this.request = request; - } - - - // --------------------------------------------------------- Public Methods - - /** - * Retrieve the character encoding for the request. - * - * @return The character encoding for the request. - */ - public String getCharacterEncoding() { - return request.getCharacterEncoding(); - } - - /** - * Retrieve the content type of the request. - * - * @return The content type of the request. - */ - public String getContentType() { - return request.getContentType(); - } - - /** - * Retrieve the content length of the request. - * - * @return The content length of the request. - */ - public int getContentLength() { - return request.getContentLength(); - } - - /** - * Retrieve the input stream for the request. - * - * @return The input stream for the request. - * - * @throws IOException if a problem occurs. - */ - public InputStream getInputStream() throws IOException { - return request.getPortletInputStream(); - } - - /** - * Returns a string representation of this object. - * - * @return a string representation of this object. - */ - public String toString() { - return "ContentLength=" - + this.getContentLength() - + ", ContentType=" - + this.getContentType(); - } - -} diff --git a/fine-commons-fileupload/src/com/fr/third/org/apache/commons/fileupload/portlet/package.html b/fine-commons-fileupload/src/com/fr/third/org/apache/commons/fileupload/portlet/package.html deleted file mode 100755 index 887ac3187..000000000 --- a/fine-commons-fileupload/src/com/fr/third/org/apache/commons/fileupload/portlet/package.html +++ /dev/null @@ -1,49 +0,0 @@ - - - - -
- An implementation of
- {@link com.fr.third.org.apache.commons.fileupload.FileUpload FileUpload}
- for use in portlets conforming to JSR 168. This implementation requires
- only access to the portlet's current ActionRequest instance,
- and a suitable
- {@link com.fr.third.org.apache.commons.fileupload.FileItemFactory FileItemFactory}
- implementation, such as
- {@link com.fr.third.org.apache.commons.fileupload.disk.DiskFileItemFactory DiskFileItemFactory}.
-
- The following code fragment demonstrates typical usage. -
-- DiskFileItemFactory factory = new DiskFileItemFactory(); - // Configure the factory here, if desired. - PortletFileUpload upload = new PortletFileUpload(factory); - // Configure the uploader here, if desired. - List fileItems = upload.parseRequest(request); --
- Please see the FileUpload - User Guide - for further details and examples of how to use this package. -
- -