/*
|
* 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 frame.upload;
|
|
import java.io.File;
|
import java.util.List;
|
import javax.servlet.http.HttpServletRequest;
|
|
import frame.upload.DefaultFileItemFactory;
|
import frame.upload.FileItemFactory;
|
import frame.upload.FileUploadBase;
|
import frame.upload.FileUploadException;
|
|
/**
|
* <p>High level API for processing file uploads.</p>
|
*
|
* <p>This class handles multiple files per single HTML widget, sent using
|
* <code>multipart/mixed</code> encoding type, as specified by
|
* <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>. Use {@link
|
* #parseRequest(HttpServletRequest)} to acquire a list of {@link
|
* frame.upload.FileItem}s associated with a given HTML
|
* widget.</p>
|
*
|
* <p>Individual parts will be stored in temporary disk storage or in memory,
|
* depending on their size, and will be available as {@link
|
* frame.upload.FileItem}s.</p>
|
*
|
* @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
|
* @author <a href="mailto:dlr@collab.net">Daniel Rall</a>
|
* @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
|
* @author <a href="mailto:jmcnally@collab.net">John McNally</a>
|
* @author <a href="mailto:martinc@apache.org">Martin Cooper</a>
|
* @author Sean C. Sullivan
|
*
|
* @version $Id: DiskFileUpload.java 479484 2006-11-27 01:06:53Z jochen $
|
*
|
* @deprecated Use <code>ServletFileUpload</code> together with
|
* <code>DiskFileItemFactory</code> instead.
|
*/
|
public class DiskFileUpload
|
extends FileUploadBase {
|
|
// ----------------------------------------------------------- Data members
|
|
|
/**
|
* The factory to use to create new form items.
|
*/
|
private DefaultFileItemFactory fileItemFactory;
|
|
|
// ----------------------------------------------------------- Constructors
|
|
|
/**
|
* Constructs an instance of this class which uses the default factory to
|
* create <code>FileItem</code> instances.
|
*
|
* @see #DiskFileUpload(DefaultFileItemFactory fileItemFactory)
|
*
|
* @deprecated Use <code>FileUpload</code> instead.
|
*/
|
public DiskFileUpload() {
|
super();
|
this.fileItemFactory = new DefaultFileItemFactory();
|
}
|
|
|
/**
|
* Constructs an instance of this class which uses the supplied factory to
|
* create <code>FileItem</code> instances.
|
*
|
* @see #DiskFileUpload()
|
* @param fileItemFactory The file item factory to use.
|
*
|
* @deprecated Use <code>FileUpload</code> instead.
|
*/
|
public DiskFileUpload(DefaultFileItemFactory fileItemFactory) {
|
super();
|
this.fileItemFactory = fileItemFactory;
|
}
|
|
|
// ----------------------------------------------------- Property accessors
|
|
|
/**
|
* Returns the factory class used when creating file items.
|
*
|
* @return The factory class for new file items.
|
*
|
* @deprecated Use <code>FileUpload</code> instead.
|
*/
|
public FileItemFactory getFileItemFactory() {
|
return fileItemFactory;
|
}
|
|
|
/**
|
* Sets the factory class to use when creating file items. The factory must
|
* be an instance of <code>DefaultFileItemFactory</code> or a subclass
|
* thereof, or else a <code>ClassCastException</code> will be thrown.
|
*
|
* @param factory The factory class for new file items.
|
*
|
* @deprecated Use <code>FileUpload</code> instead.
|
*/
|
public void setFileItemFactory(FileItemFactory factory) {
|
this.fileItemFactory = (DefaultFileItemFactory) factory;
|
}
|
|
|
/**
|
* Returns the size threshold beyond which files are written directly to
|
* disk.
|
*
|
* @return The size threshold, in bytes.
|
*
|
* @see #setSizeThreshold(int)
|
*
|
* @deprecated Use <code>DiskFileItemFactory</code> instead.
|
*/
|
public int getSizeThreshold() {
|
return fileItemFactory.getSizeThreshold();
|
}
|
|
|
/**
|
* Sets the size threshold beyond which files are written directly to disk.
|
*
|
* @param sizeThreshold The size threshold, in bytes.
|
*
|
* @see #getSizeThreshold()
|
*
|
* @deprecated Use <code>DiskFileItemFactory</code> instead.
|
*/
|
public void setSizeThreshold(int sizeThreshold) {
|
fileItemFactory.setSizeThreshold(sizeThreshold);
|
}
|
|
|
/**
|
* Returns the location used to temporarily store files that are larger
|
* than the configured size threshold.
|
*
|
* @return The path to the temporary file location.
|
*
|
* @see #setRepositoryPath(String)
|
*
|
* @deprecated Use <code>DiskFileItemFactory</code> instead.
|
*/
|
public String getRepositoryPath() {
|
return fileItemFactory.getRepository().getPath();
|
}
|
|
|
/**
|
* Sets the location used to temporarily store files that are larger
|
* than the configured size threshold.
|
*
|
* @param repositoryPath The path to the temporary file location.
|
*
|
* @see #getRepositoryPath()
|
*
|
* @deprecated Use <code>DiskFileItemFactory</code> instead.
|
*/
|
public void setRepositoryPath(String repositoryPath) {
|
fileItemFactory.setRepository(new File(repositoryPath));
|
}
|
|
|
// --------------------------------------------------------- Public methods
|
|
|
/**
|
* Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>
|
* compliant <code>multipart/form-data</code> stream. If files are stored
|
* on disk, the path is given by <code>getRepository()</code>.
|
*
|
* @param req The servlet request to be parsed. Must be non-null.
|
* @param sizeThreshold The max size in bytes to be stored in memory.
|
* @param sizeMax The maximum allowed upload size, in bytes.
|
* @param path The location where the files should be stored.
|
*
|
* @return A list of <code>FileItem</code> 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.
|
*
|
* @deprecated Use <code>ServletFileUpload</code> instead.
|
*/
|
public List /* FileItem */ parseRequest(HttpServletRequest req,
|
int sizeThreshold,
|
long sizeMax, String path)
|
throws FileUploadException {
|
setSizeThreshold(sizeThreshold);
|
setSizeMax(sizeMax);
|
setRepositoryPath(path);
|
return parseRequest(req);
|
}
|
|
}
|
