org.apache.commons.fileupload.DefaultFileItemFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-fileupload Show documentation
Show all versions of commons-fileupload Show documentation
The Apache Commons FileUpload component provides a simple yet flexible means of adding support for multipart
file upload functionality to servlets and web applications.
/*
* 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;
import java.io.File;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
/**
* The default {@link org.apache.commons.fileupload.FileItemFactory}
* implementation. This implementation creates
* {@link org.apache.commons.fileupload.FileItem} instances which keep their
* content either in memory, for smaller items, or in a temporary file on disk,
* for larger items. The size threshold, above which content will be stored on
* disk, is configurable, as is the directory in which temporary files will be
* created.
*
* If not otherwise configured, the default configuration values are as
* follows:
*
* - Size threshold is 10KB.
* - Repository is the system default temp directory, as returned by
*
System.getProperty("java.io.tmpdir").
*
*
* @deprecated 1.1 Use DiskFileItemFactory instead.
*/
@Deprecated
public class DefaultFileItemFactory extends DiskFileItemFactory {
// ----------------------------------------------------------- Constructors
/**
* Constructs an unconfigured instance of this class. The resulting factory
* may be configured by calling the appropriate setter methods.
*
* @deprecated 1.1 Use DiskFileItemFactory instead.
*/
@Deprecated
public DefaultFileItemFactory() {
super();
}
/**
* Constructs a preconfigured instance of this class.
*
* @param sizeThreshold The threshold, in bytes, below which items will be
* retained in memory and above which they will be
* stored as a file.
* @param repository The data repository, which is the directory in
* which files will be created, should the item size
* exceed the threshold.
*
* @deprecated 1.1 Use DiskFileItemFactory instead.
*/
@Deprecated
public DefaultFileItemFactory(int sizeThreshold, File repository) {
super(sizeThreshold, repository);
}
// --------------------------------------------------------- Public Methods
/**
* Create a new {@link org.apache.commons.fileupload.DefaultFileItem}
* instance from the supplied parameters and the local factory
* configuration.
*
* @param fieldName The name of the form field.
* @param contentType The content type of the form field.
* @param isFormField true if this is a plain form field;
* false otherwise.
* @param fileName The name of the uploaded file, if any, as supplied
* by the browser or other client.
*
* @return The newly created file item.
*
* @deprecated 1.1 Use DiskFileItemFactory instead.
*/
@Override
@Deprecated
public FileItem createItem(
String fieldName,
String contentType,
boolean isFormField,
String fileName
) {
return new DefaultFileItem(fieldName, contentType,
isFormField, fileName, getSizeThreshold(), getRepository());
}
}