<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 03 09:46:57 UTC 2010 --> <TITLE> FileUploadBase </TITLE> <META NAME="date" CONTENT="2010-12-03"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="FileUploadBase"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FileUploadBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../org/apache/commons/fileupload/FileUpload.html" title="class in org.apache.commons.fileupload"><B>PREV CLASS</B></A> <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.FileItemIteratorImpl.html" title="class in org.apache.commons.fileupload"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?org/apache/commons/fileupload/FileUploadBase.html" target="_top"><B>FRAMES</B></A> <A HREF="FileUploadBase.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> org.apache.commons.fileupload</FONT> <BR> Class FileUploadBase</H2> <PRE> java.lang.Object <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.fileupload.FileUploadBase</B> </PRE> <DL> <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/commons/fileupload/DiskFileUpload.html" title="class in org.apache.commons.fileupload">DiskFileUpload</A>, <A HREF="../../../../org/apache/commons/fileupload/FileUpload.html" title="class in org.apache.commons.fileupload">FileUpload</A></DD> </DL> <HR> <DL> <DT><PRE>public abstract class <B>FileUploadBase</B><DT>extends java.lang.Object</DL> </PRE> <P> <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 <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#parseRequest(javax.servlet.http.HttpServletRequest)"><CODE>parseRequest(HttpServletRequest)</CODE></A> to acquire a list of <A HREF="../../../../org/apache/commons/fileupload/FileItem.html" title="interface in org.apache.commons.fileupload"><CODE>FileItem</CODE></A>s associated with a given HTML widget.</p> <p>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.</p> <P> <P> <DL> <DT><B>Version:</B></DT> <DD>$Id: FileUploadBase.java 607869 2008-01-01 16:42:17Z jochen $</DD> <DT><B>Author:</B></DT> <DD><a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>, <a href="mailto:dlr@collab.net">Daniel Rall</a>, <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>, <a href="mailto:jmcnally@collab.net">John McNally</a>, <a href="mailto:martinc@apache.org">Martin Cooper</a>, Sean C. Sullivan</DD> </DL> <HR> <P> <!-- ======== NESTED CLASS SUMMARY ======== --> <A NAME="nested_class_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Nested Class Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.FileItemIteratorImpl.html" title="class in org.apache.commons.fileupload">FileUploadBase.FileItemIteratorImpl</A></B></CODE> <BR> The iterator, which is returned by <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getItemIterator(org.apache.commons.fileupload.RequestContext)"><CODE>getItemIterator(RequestContext)</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.FileSizeLimitExceededException.html" title="class in org.apache.commons.fileupload">FileUploadBase.FileSizeLimitExceededException</A></B></CODE> <BR> Thrown to indicate that A files size exceeds the configured maximum.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.FileUploadIOException.html" title="class in org.apache.commons.fileupload">FileUploadBase.FileUploadIOException</A></B></CODE> <BR> This exception is thrown for hiding an inner <A HREF="../../../../org/apache/commons/fileupload/FileUploadException.html" title="class in org.apache.commons.fileupload"><CODE>FileUploadException</CODE></A> in an <CODE>IOException</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.InvalidContentTypeException.html" title="class in org.apache.commons.fileupload">FileUploadBase.InvalidContentTypeException</A></B></CODE> <BR> Thrown to indicate that the request is not a multipart request.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.IOFileUploadException.html" title="class in org.apache.commons.fileupload">FileUploadBase.IOFileUploadException</A></B></CODE> <BR> Thrown to indicate an IOException.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected static class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.SizeException.html" title="class in org.apache.commons.fileupload">FileUploadBase.SizeException</A></B></CODE> <BR> This exception is thrown, if a requests permitted size is exceeded.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.SizeLimitExceededException.html" title="class in org.apache.commons.fileupload">FileUploadBase.SizeLimitExceededException</A></B></CODE> <BR> Thrown to indicate that the request size exceeds the configured maximum.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.UnknownSizeException.html" title="class in org.apache.commons.fileupload">FileUploadBase.UnknownSizeException</A></B></CODE> <BR> <B>Deprecated.</B> <I>As of commons-fileupload 1.2, the presence of a content-length header is no longer required.</I></TD> </TR> </TABLE> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Field Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#ATTACHMENT">ATTACHMENT</A></B></CODE> <BR> Content-disposition value for file attachment.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#CONTENT_DISPOSITION">CONTENT_DISPOSITION</A></B></CODE> <BR> HTTP content disposition header name.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#CONTENT_LENGTH">CONTENT_LENGTH</A></B></CODE> <BR> HTTP content length header name.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#CONTENT_TYPE">CONTENT_TYPE</A></B></CODE> <BR> HTTP content type header name.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private long</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#fileSizeMax">fileSizeMax</A></B></CODE> <BR> The maximum size permitted for a single uploaded file, as opposed to <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#sizeMax"><CODE>sizeMax</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#FORM_DATA">FORM_DATA</A></B></CODE> <BR> Content-disposition value for form data.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#headerEncoding">headerEncoding</A></B></CODE> <BR> The content encoding to use when reading part headers.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private <A HREF="../../../../org/apache/commons/fileupload/ProgressListener.html" title="interface in org.apache.commons.fileupload">ProgressListener</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#listener">listener</A></B></CODE> <BR> The progress listener.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#MAX_HEADER_SIZE">MAX_HEADER_SIZE</A></B></CODE> <BR> <B>Deprecated.</B> <I>This constant is no longer used. As of commons-fileupload 1.2, the only applicable limit is the total size of a parts headers, <A HREF="../../../../org/apache/commons/fileupload/MultipartStream.html#HEADER_PART_SIZE_MAX"><CODE>MultipartStream.HEADER_PART_SIZE_MAX</CODE></A>.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#MULTIPART">MULTIPART</A></B></CODE> <BR> Part of HTTP content type header.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#MULTIPART_FORM_DATA">MULTIPART_FORM_DATA</A></B></CODE> <BR> HTTP content type header for multipart forms.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#MULTIPART_MIXED">MULTIPART_MIXED</A></B></CODE> <BR> HTTP content type header for multiple uploads.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private long</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#sizeMax">sizeMax</A></B></CODE> <BR> The maximum size permitted for the complete request, as opposed to <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#fileSizeMax"><CODE>fileSizeMax</CODE></A>.</TD> </TR> </TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#FileUploadBase()">FileUploadBase</A></B>()</CODE> <BR> </TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected <A HREF="../../../../org/apache/commons/fileupload/FileItem.html" title="interface in org.apache.commons.fileupload">FileItem</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#createItem(java.util.Map, boolean)">createItem</A></B>(java.util.Map headers, boolean isFormField)</CODE> <BR> <B>Deprecated.</B> <I>This method is no longer used in favour of internally created instances of <A HREF="../../../../org/apache/commons/fileupload/FileItem.html" title="interface in org.apache.commons.fileupload"><CODE>FileItem</CODE></A>.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected byte[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getBoundary(java.lang.String)">getBoundary</A></B>(java.lang.String contentType)</CODE> <BR> Retrieves the boundary from the <code>Content-type</code> header.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFieldName(org.apache.commons.fileupload.FileItemHeaders)">getFieldName</A></B>(<A HREF="../../../../org/apache/commons/fileupload/FileItemHeaders.html" title="interface in org.apache.commons.fileupload">FileItemHeaders</A> headers)</CODE> <BR> Retrieves the field name from the <code>Content-disposition</code> header.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFieldName(java.util.Map)">getFieldName</A></B>(java.util.Map headers)</CODE> <BR> <B>Deprecated.</B> <I>Use <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFieldName(org.apache.commons.fileupload.FileItemHeaders)"><CODE>getFieldName(FileItemHeaders)</CODE></A>.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFieldName(java.lang.String)">getFieldName</A></B>(java.lang.String pContentDisposition)</CODE> <BR> Returns the field name, which is given by the content-disposition header.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract <A HREF="../../../../org/apache/commons/fileupload/FileItemFactory.html" title="interface in org.apache.commons.fileupload">FileItemFactory</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFileItemFactory()">getFileItemFactory</A></B>()</CODE> <BR> Returns the factory class used when creating file items.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFileName(org.apache.commons.fileupload.FileItemHeaders)">getFileName</A></B>(<A HREF="../../../../org/apache/commons/fileupload/FileItemHeaders.html" title="interface in org.apache.commons.fileupload">FileItemHeaders</A> headers)</CODE> <BR> Retrieves the file name from the <code>Content-disposition</code> header.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFileName(java.util.Map)">getFileName</A></B>(java.util.Map headers)</CODE> <BR> <B>Deprecated.</B> <I>Use <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFileName(org.apache.commons.fileupload.FileItemHeaders)"><CODE>getFileName(FileItemHeaders)</CODE></A>.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFileName(java.lang.String)">getFileName</A></B>(java.lang.String pContentDisposition)</CODE> <BR> Returns the given content-disposition headers file name.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> long</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFileSizeMax()">getFileSizeMax</A></B>()</CODE> <BR> Returns the maximum allowed size of a single uploaded file, as opposed to <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getSizeMax()"><CODE>getSizeMax()</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getHeader(java.util.Map, java.lang.String)">getHeader</A></B>(java.util.Map headers, java.lang.String name)</CODE> <BR> <B>Deprecated.</B> <I>Use <A HREF="../../../../org/apache/commons/fileupload/FileItemHeaders.html#getHeader(java.lang.String)"><CODE>FileItemHeaders.getHeader(String)</CODE></A>.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getHeaderEncoding()">getHeaderEncoding</A></B>()</CODE> <BR> Retrieves the character encoding used when reading the headers of an individual part.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../org/apache/commons/fileupload/FileItemIterator.html" title="interface in org.apache.commons.fileupload">FileItemIterator</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getItemIterator(org.apache.commons.fileupload.RequestContext)">getItemIterator</A></B>(<A HREF="../../../../org/apache/commons/fileupload/RequestContext.html" title="interface in org.apache.commons.fileupload">RequestContext</A> ctx)</CODE> <BR> Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant <code>multipart/form-data</code> stream.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected <A HREF="../../../../org/apache/commons/fileupload/FileItemHeaders.html" title="interface in org.apache.commons.fileupload">FileItemHeaders</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getParsedHeaders(java.lang.String)">getParsedHeaders</A></B>(java.lang.String headerPart)</CODE> <BR> Parses the <code>header-part</code> and returns as key/value pairs.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../org/apache/commons/fileupload/ProgressListener.html" title="interface in org.apache.commons.fileupload">ProgressListener</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getProgressListener()">getProgressListener</A></B>()</CODE> <BR> Returns the progress listener.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> long</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getSizeMax()">getSizeMax</A></B>()</CODE> <BR> Returns the maximum allowed size of a complete request, as opposed to <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFileSizeMax()"><CODE>getFileSizeMax()</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#isMultipartContent(javax.servlet.http.HttpServletRequest)">isMultipartContent</A></B>(javax.servlet.http.HttpServletRequest req)</CODE> <BR> <B>Deprecated.</B> <I>Use the method on <code>ServletFileUpload</code> instead.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#isMultipartContent(org.apache.commons.fileupload.RequestContext)">isMultipartContent</A></B>(<A HREF="../../../../org/apache/commons/fileupload/RequestContext.html" title="interface in org.apache.commons.fileupload">RequestContext</A> ctx)</CODE> <BR> Utility method that determines whether the request contains multipart content.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected <A HREF="../../../../org/apache/commons/fileupload/util/FileItemHeadersImpl.html" title="class in org.apache.commons.fileupload.util">FileItemHeadersImpl</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#newFileItemHeaders()">newFileItemHeaders</A></B>()</CODE> <BR> Creates a new instance of <A HREF="../../../../org/apache/commons/fileupload/FileItemHeaders.html" title="interface in org.apache.commons.fileupload"><CODE>FileItemHeaders</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#parseEndOfLine(java.lang.String, int)">parseEndOfLine</A></B>(java.lang.String headerPart, int end)</CODE> <BR> Skips bytes until the end of the current line.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#parseHeaderLine(org.apache.commons.fileupload.util.FileItemHeadersImpl, java.lang.String)">parseHeaderLine</A></B>(<A HREF="../../../../org/apache/commons/fileupload/util/FileItemHeadersImpl.html" title="class in org.apache.commons.fileupload.util">FileItemHeadersImpl</A> headers, java.lang.String header)</CODE> <BR> Reads the next header line.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.util.Map</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#parseHeaders(java.lang.String)">parseHeaders</A></B>(java.lang.String headerPart)</CODE> <BR> <B>Deprecated.</B> <I>Use <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getParsedHeaders(java.lang.String)"><CODE>getParsedHeaders(String)</CODE></A></I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.List</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#parseRequest(javax.servlet.http.HttpServletRequest)">parseRequest</A></B>(javax.servlet.http.HttpServletRequest req)</CODE> <BR> <B>Deprecated.</B> <I>Use the method in <code>ServletFileUpload</code> instead.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.List</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#parseRequest(org.apache.commons.fileupload.RequestContext)">parseRequest</A></B>(<A HREF="../../../../org/apache/commons/fileupload/RequestContext.html" title="interface in org.apache.commons.fileupload">RequestContext</A> ctx)</CODE> <BR> Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant <code>multipart/form-data</code> stream.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#setFileItemFactory(org.apache.commons.fileupload.FileItemFactory)">setFileItemFactory</A></B>(<A HREF="../../../../org/apache/commons/fileupload/FileItemFactory.html" title="interface in org.apache.commons.fileupload">FileItemFactory</A> factory)</CODE> <BR> Sets the factory class to use when creating file items.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#setFileSizeMax(long)">setFileSizeMax</A></B>(long fileSizeMax)</CODE> <BR> Sets the maximum allowed size of a single uploaded file, as opposed to <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getSizeMax()"><CODE>getSizeMax()</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#setHeaderEncoding(java.lang.String)">setHeaderEncoding</A></B>(java.lang.String encoding)</CODE> <BR> Specifies the character encoding to be used when reading the headers of individual part.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#setProgressListener(org.apache.commons.fileupload.ProgressListener)">setProgressListener</A></B>(<A HREF="../../../../org/apache/commons/fileupload/ProgressListener.html" title="interface in org.apache.commons.fileupload">ProgressListener</A> pListener)</CODE> <BR> Sets the progress listener.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#setSizeMax(long)">setSizeMax</A></B>(long sizeMax)</CODE> <BR> Sets the maximum allowed size of a complete request, as opposed to <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#setFileSizeMax(long)"><CODE>setFileSizeMax(long)</CODE></A>.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Field Detail</B></FONT></TH> </TR> </TABLE> <A NAME="CONTENT_TYPE"><!-- --></A><H3> CONTENT_TYPE</H3> <PRE> public static final java.lang.String <B>CONTENT_TYPE</B></PRE> <DL> <DD>HTTP content type header name. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.commons.fileupload.FileUploadBase.CONTENT_TYPE">Constant Field Values</A></DL> </DL> <HR> <A NAME="CONTENT_DISPOSITION"><!-- --></A><H3> CONTENT_DISPOSITION</H3> <PRE> public static final java.lang.String <B>CONTENT_DISPOSITION</B></PRE> <DL> <DD>HTTP content disposition header name. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.commons.fileupload.FileUploadBase.CONTENT_DISPOSITION">Constant Field Values</A></DL> </DL> <HR> <A NAME="CONTENT_LENGTH"><!-- --></A><H3> CONTENT_LENGTH</H3> <PRE> public static final java.lang.String <B>CONTENT_LENGTH</B></PRE> <DL> <DD>HTTP content length header name. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.commons.fileupload.FileUploadBase.CONTENT_LENGTH">Constant Field Values</A></DL> </DL> <HR> <A NAME="FORM_DATA"><!-- --></A><H3> FORM_DATA</H3> <PRE> public static final java.lang.String <B>FORM_DATA</B></PRE> <DL> <DD>Content-disposition value for form data. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.commons.fileupload.FileUploadBase.FORM_DATA">Constant Field Values</A></DL> </DL> <HR> <A NAME="ATTACHMENT"><!-- --></A><H3> ATTACHMENT</H3> <PRE> public static final java.lang.String <B>ATTACHMENT</B></PRE> <DL> <DD>Content-disposition value for file attachment. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.commons.fileupload.FileUploadBase.ATTACHMENT">Constant Field Values</A></DL> </DL> <HR> <A NAME="MULTIPART"><!-- --></A><H3> MULTIPART</H3> <PRE> public static final java.lang.String <B>MULTIPART</B></PRE> <DL> <DD>Part of HTTP content type header. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.commons.fileupload.FileUploadBase.MULTIPART">Constant Field Values</A></DL> </DL> <HR> <A NAME="MULTIPART_FORM_DATA"><!-- --></A><H3> MULTIPART_FORM_DATA</H3> <PRE> public static final java.lang.String <B>MULTIPART_FORM_DATA</B></PRE> <DL> <DD>HTTP content type header for multipart forms. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.commons.fileupload.FileUploadBase.MULTIPART_FORM_DATA">Constant Field Values</A></DL> </DL> <HR> <A NAME="MULTIPART_MIXED"><!-- --></A><H3> MULTIPART_MIXED</H3> <PRE> public static final java.lang.String <B>MULTIPART_MIXED</B></PRE> <DL> <DD>HTTP content type header for multiple uploads. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.commons.fileupload.FileUploadBase.MULTIPART_MIXED">Constant Field Values</A></DL> </DL> <HR> <A NAME="MAX_HEADER_SIZE"><!-- --></A><H3> MAX_HEADER_SIZE</H3> <PRE> public static final int <B>MAX_HEADER_SIZE</B></PRE> <DL> <DD><B>Deprecated.</B> <I>This constant is no longer used. As of commons-fileupload 1.2, the only applicable limit is the total size of a parts headers, <A HREF="../../../../org/apache/commons/fileupload/MultipartStream.html#HEADER_PART_SIZE_MAX"><CODE>MultipartStream.HEADER_PART_SIZE_MAX</CODE></A>.</I><DD>The maximum length of a single header line that will be parsed (1024 bytes). <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.commons.fileupload.FileUploadBase.MAX_HEADER_SIZE">Constant Field Values</A></DL> </DL> <HR> <A NAME="sizeMax"><!-- --></A><H3> sizeMax</H3> <PRE> private long <B>sizeMax</B></PRE> <DL> <DD>The maximum size permitted for the complete request, as opposed to <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#fileSizeMax"><CODE>fileSizeMax</CODE></A>. A value of -1 indicates no maximum. <P> <DL> </DL> </DL> <HR> <A NAME="fileSizeMax"><!-- --></A><H3> fileSizeMax</H3> <PRE> private long <B>fileSizeMax</B></PRE> <DL> <DD>The maximum size permitted for a single uploaded file, as opposed to <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#sizeMax"><CODE>sizeMax</CODE></A>. A value of -1 indicates no maximum. <P> <DL> </DL> </DL> <HR> <A NAME="headerEncoding"><!-- --></A><H3> headerEncoding</H3> <PRE> private java.lang.String <B>headerEncoding</B></PRE> <DL> <DD>The content encoding to use when reading part headers. <P> <DL> </DL> </DL> <HR> <A NAME="listener"><!-- --></A><H3> listener</H3> <PRE> private <A HREF="../../../../org/apache/commons/fileupload/ProgressListener.html" title="interface in org.apache.commons.fileupload">ProgressListener</A> <B>listener</B></PRE> <DL> <DD>The progress listener. <P> <DL> </DL> </DL> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="FileUploadBase()"><!-- --></A><H3> FileUploadBase</H3> <PRE> public <B>FileUploadBase</B>()</PRE> <DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="isMultipartContent(org.apache.commons.fileupload.RequestContext)"><!-- --></A><H3> isMultipartContent</H3> <PRE> public static final boolean <B>isMultipartContent</B>(<A HREF="../../../../org/apache/commons/fileupload/RequestContext.html" title="interface in org.apache.commons.fileupload">RequestContext</A> ctx)</PRE> <DL> <DD><p>Utility method that determines whether the request contains multipart content.</p> <p><strong>NOTE:</strong>This method will be moved to the <code>ServletFileUpload</code> class after the FileUpload 1.1 release. Unfortunately, since this method is static, it is not possible to provide its replacement until this method is removed.</p> <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>ctx</CODE> - The request context to be evaluated. Must be non-null. <DT><B>Returns:</B><DD><code>true</code> if the request is multipart; <code>false</code> otherwise.</DL> </DD> </DL> <HR> <A NAME="isMultipartContent(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> isMultipartContent</H3> <PRE> public static boolean <B>isMultipartContent</B>(javax.servlet.http.HttpServletRequest req)</PRE> <DL> <DD><B>Deprecated.</B> <I>Use the method on <code>ServletFileUpload</code> instead.</I> <P> <DD>Utility method that determines whether the request contains multipart content. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>req</CODE> - The servlet request to be evaluated. Must be non-null. <DT><B>Returns:</B><DD><code>true</code> if the request is multipart; <code>false</code> otherwise.</DL> </DD> </DL> <HR> <A NAME="getFileItemFactory()"><!-- --></A><H3> getFileItemFactory</H3> <PRE> public abstract <A HREF="../../../../org/apache/commons/fileupload/FileItemFactory.html" title="interface in org.apache.commons.fileupload">FileItemFactory</A> <B>getFileItemFactory</B>()</PRE> <DL> <DD>Returns the factory class used when creating file items. <P> <DD><DL> <DT><B>Returns:</B><DD>The factory class for new file items.</DL> </DD> </DL> <HR> <A NAME="setFileItemFactory(org.apache.commons.fileupload.FileItemFactory)"><!-- --></A><H3> setFileItemFactory</H3> <PRE> public abstract void <B>setFileItemFactory</B>(<A HREF="../../../../org/apache/commons/fileupload/FileItemFactory.html" title="interface in org.apache.commons.fileupload">FileItemFactory</A> factory)</PRE> <DL> <DD>Sets the factory class to use when creating file items. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>factory</CODE> - The factory class for new file items.</DL> </DD> </DL> <HR> <A NAME="getSizeMax()"><!-- --></A><H3> getSizeMax</H3> <PRE> public long <B>getSizeMax</B>()</PRE> <DL> <DD>Returns the maximum allowed size of a complete request, as opposed to <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFileSizeMax()"><CODE>getFileSizeMax()</CODE></A>. <P> <DD><DL> <DT><B>Returns:</B><DD>The maximum allowed size, in bytes. The default value of -1 indicates, that there is no limit.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#setSizeMax(long)"><CODE>setSizeMax(long)</CODE></A></DL> </DD> </DL> <HR> <A NAME="setSizeMax(long)"><!-- --></A><H3> setSizeMax</H3> <PRE> public void <B>setSizeMax</B>(long sizeMax)</PRE> <DL> <DD>Sets the maximum allowed size of a complete request, as opposed to <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#setFileSizeMax(long)"><CODE>setFileSizeMax(long)</CODE></A>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>sizeMax</CODE> - The maximum allowed size, in bytes. The default value of -1 indicates, that there is no limit.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getSizeMax()"><CODE>getSizeMax()</CODE></A></DL> </DD> </DL> <HR> <A NAME="getFileSizeMax()"><!-- --></A><H3> getFileSizeMax</H3> <PRE> public long <B>getFileSizeMax</B>()</PRE> <DL> <DD>Returns the maximum allowed size of a single uploaded file, as opposed to <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getSizeMax()"><CODE>getSizeMax()</CODE></A>. <P> <DD><DL> <DT><B>Returns:</B><DD>Maximum size of a single uploaded file.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#setFileSizeMax(long)"><CODE>setFileSizeMax(long)</CODE></A></DL> </DD> </DL> <HR> <A NAME="setFileSizeMax(long)"><!-- --></A><H3> setFileSizeMax</H3> <PRE> public void <B>setFileSizeMax</B>(long fileSizeMax)</PRE> <DL> <DD>Sets the maximum allowed size of a single uploaded file, as opposed to <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getSizeMax()"><CODE>getSizeMax()</CODE></A>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>fileSizeMax</CODE> - Maximum size of a single uploaded file.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFileSizeMax()"><CODE>getFileSizeMax()</CODE></A></DL> </DD> </DL> <HR> <A NAME="getHeaderEncoding()"><!-- --></A><H3> getHeaderEncoding</H3> <PRE> public java.lang.String <B>getHeaderEncoding</B>()</PRE> <DL> <DD>Retrieves the character encoding used when reading the headers of an individual part. When not specified, or <code>null</code>, the request encoding is used. If that is also not specified, or <code>null</code>, the platform default encoding is used. <P> <DD><DL> <DT><B>Returns:</B><DD>The encoding used to read part headers.</DL> </DD> </DL> <HR> <A NAME="setHeaderEncoding(java.lang.String)"><!-- --></A><H3> setHeaderEncoding</H3> <PRE> public void <B>setHeaderEncoding</B>(java.lang.String encoding)</PRE> <DL> <DD>Specifies the character encoding to be used when reading the headers of individual part. When not specified, or <code>null</code>, the request encoding is used. If that is also not specified, or <code>null</code>, the platform default encoding is used. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>encoding</CODE> - The encoding used to read part headers.</DL> </DD> </DL> <HR> <A NAME="parseRequest(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> parseRequest</H3> <PRE> public java.util.List <B>parseRequest</B>(javax.servlet.http.HttpServletRequest req) throws <A HREF="../../../../org/apache/commons/fileupload/FileUploadException.html" title="class in org.apache.commons.fileupload">FileUploadException</A></PRE> <DL> <DD><B>Deprecated.</B> <I>Use the method in <code>ServletFileUpload</code> instead.</I> <P> <DD>Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant <code>multipart/form-data</code> stream. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>req</CODE> - The servlet request to be parsed. <DT><B>Returns:</B><DD>A list of <code>FileItem</code> instances parsed from the request, in the order that they were transmitted. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../org/apache/commons/fileupload/FileUploadException.html" title="class in org.apache.commons.fileupload">FileUploadException</A></CODE> - if there are problems reading/parsing the request or storing files.</DL> </DD> </DL> <HR> <A NAME="getItemIterator(org.apache.commons.fileupload.RequestContext)"><!-- --></A><H3> getItemIterator</H3> <PRE> public <A HREF="../../../../org/apache/commons/fileupload/FileItemIterator.html" title="interface in org.apache.commons.fileupload">FileItemIterator</A> <B>getItemIterator</B>(<A HREF="../../../../org/apache/commons/fileupload/RequestContext.html" title="interface in org.apache.commons.fileupload">RequestContext</A> ctx) throws <A HREF="../../../../org/apache/commons/fileupload/FileUploadException.html" title="class in org.apache.commons.fileupload">FileUploadException</A>, java.io.IOException</PRE> <DL> <DD>Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant <code>multipart/form-data</code> stream. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>ctx</CODE> - The context for the request to be parsed. <DT><B>Returns:</B><DD>An iterator to instances of <code>FileItemStream</code> parsed from the request, in the order that they were transmitted. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../org/apache/commons/fileupload/FileUploadException.html" title="class in org.apache.commons.fileupload">FileUploadException</A></CODE> - if there are problems reading/parsing the request or storing files. <DD><CODE>java.io.IOException</CODE> - An I/O error occurred. This may be a network error while communicating with the client or a problem while storing the uploaded content.</DL> </DD> </DL> <HR> <A NAME="parseRequest(org.apache.commons.fileupload.RequestContext)"><!-- --></A><H3> parseRequest</H3> <PRE> public java.util.List <B>parseRequest</B>(<A HREF="../../../../org/apache/commons/fileupload/RequestContext.html" title="interface in org.apache.commons.fileupload">RequestContext</A> ctx) throws <A HREF="../../../../org/apache/commons/fileupload/FileUploadException.html" title="class in org.apache.commons.fileupload">FileUploadException</A></PRE> <DL> <DD>Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant <code>multipart/form-data</code> stream. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>ctx</CODE> - The context for the request to be parsed. <DT><B>Returns:</B><DD>A list of <code>FileItem</code> instances parsed from the request, in the order that they were transmitted. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../org/apache/commons/fileupload/FileUploadException.html" title="class in org.apache.commons.fileupload">FileUploadException</A></CODE> - if there are problems reading/parsing the request or storing files.</DL> </DD> </DL> <HR> <A NAME="getBoundary(java.lang.String)"><!-- --></A><H3> getBoundary</H3> <PRE> protected byte[] <B>getBoundary</B>(java.lang.String contentType)</PRE> <DL> <DD>Retrieves the boundary from the <code>Content-type</code> header. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>contentType</CODE> - The value of the content type header from which to extract the boundary value. <DT><B>Returns:</B><DD>The boundary, as a byte array.</DL> </DD> </DL> <HR> <A NAME="getFileName(java.util.Map)"><!-- --></A><H3> getFileName</H3> <PRE> protected java.lang.String <B>getFileName</B>(java.util.Map headers)</PRE> <DL> <DD><B>Deprecated.</B> <I>Use <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFileName(org.apache.commons.fileupload.FileItemHeaders)"><CODE>getFileName(FileItemHeaders)</CODE></A>.</I> <P> <DD>Retrieves the file name from the <code>Content-disposition</code> header. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>headers</CODE> - A <code>Map</code> containing the HTTP request headers. <DT><B>Returns:</B><DD>The file name for the current <code>encapsulation</code>.</DL> </DD> </DL> <HR> <A NAME="getFileName(org.apache.commons.fileupload.FileItemHeaders)"><!-- --></A><H3> getFileName</H3> <PRE> protected java.lang.String <B>getFileName</B>(<A HREF="../../../../org/apache/commons/fileupload/FileItemHeaders.html" title="interface in org.apache.commons.fileupload">FileItemHeaders</A> headers)</PRE> <DL> <DD>Retrieves the file name from the <code>Content-disposition</code> header. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>headers</CODE> - The HTTP headers object. <DT><B>Returns:</B><DD>The file name for the current <code>encapsulation</code>.</DL> </DD> </DL> <HR> <A NAME="getFileName(java.lang.String)"><!-- --></A><H3> getFileName</H3> <PRE> private java.lang.String <B>getFileName</B>(java.lang.String pContentDisposition)</PRE> <DL> <DD>Returns the given content-disposition headers file name. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>pContentDisposition</CODE> - The content-disposition headers value. <DT><B>Returns:</B><DD>The file name</DL> </DD> </DL> <HR> <A NAME="getFieldName(org.apache.commons.fileupload.FileItemHeaders)"><!-- --></A><H3> getFieldName</H3> <PRE> protected java.lang.String <B>getFieldName</B>(<A HREF="../../../../org/apache/commons/fileupload/FileItemHeaders.html" title="interface in org.apache.commons.fileupload">FileItemHeaders</A> headers)</PRE> <DL> <DD>Retrieves the field name from the <code>Content-disposition</code> header. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>headers</CODE> - A <code>Map</code> containing the HTTP request headers. <DT><B>Returns:</B><DD>The field name for the current <code>encapsulation</code>.</DL> </DD> </DL> <HR> <A NAME="getFieldName(java.lang.String)"><!-- --></A><H3> getFieldName</H3> <PRE> private java.lang.String <B>getFieldName</B>(java.lang.String pContentDisposition)</PRE> <DL> <DD>Returns the field name, which is given by the content-disposition header. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>pContentDisposition</CODE> - The content-dispositions header value. <DT><B>Returns:</B><DD>The field jake</DL> </DD> </DL> <HR> <A NAME="getFieldName(java.util.Map)"><!-- --></A><H3> getFieldName</H3> <PRE> protected java.lang.String <B>getFieldName</B>(java.util.Map headers)</PRE> <DL> <DD><B>Deprecated.</B> <I>Use <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getFieldName(org.apache.commons.fileupload.FileItemHeaders)"><CODE>getFieldName(FileItemHeaders)</CODE></A>.</I> <P> <DD>Retrieves the field name from the <code>Content-disposition</code> header. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>headers</CODE> - A <code>Map</code> containing the HTTP request headers. <DT><B>Returns:</B><DD>The field name for the current <code>encapsulation</code>.</DL> </DD> </DL> <HR> <A NAME="createItem(java.util.Map, boolean)"><!-- --></A><H3> createItem</H3> <PRE> protected <A HREF="../../../../org/apache/commons/fileupload/FileItem.html" title="interface in org.apache.commons.fileupload">FileItem</A> <B>createItem</B>(java.util.Map headers, boolean isFormField) throws <A HREF="../../../../org/apache/commons/fileupload/FileUploadException.html" title="class in org.apache.commons.fileupload">FileUploadException</A></PRE> <DL> <DD><B>Deprecated.</B> <I>This method is no longer used in favour of internally created instances of <A HREF="../../../../org/apache/commons/fileupload/FileItem.html" title="interface in org.apache.commons.fileupload"><CODE>FileItem</CODE></A>.</I> <P> <DD>Creates a new <A HREF="../../../../org/apache/commons/fileupload/FileItem.html" title="interface in org.apache.commons.fileupload"><CODE>FileItem</CODE></A> instance. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>headers</CODE> - A <code>Map</code> containing the HTTP request headers.<DD><CODE>isFormField</CODE> - Whether or not this item is a form field, as opposed to a file. <DT><B>Returns:</B><DD>A newly created <code>FileItem</code> instance. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../org/apache/commons/fileupload/FileUploadException.html" title="class in org.apache.commons.fileupload">FileUploadException</A></CODE> - if an error occurs.</DL> </DD> </DL> <HR> <A NAME="getParsedHeaders(java.lang.String)"><!-- --></A><H3> getParsedHeaders</H3> <PRE> protected <A HREF="../../../../org/apache/commons/fileupload/FileItemHeaders.html" title="interface in org.apache.commons.fileupload">FileItemHeaders</A> <B>getParsedHeaders</B>(java.lang.String headerPart)</PRE> <DL> <DD><p> Parses the <code>header-part</code> and returns as key/value pairs. <p> If there are multiple headers of the same names, the name will map to a comma-separated list containing the values. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>headerPart</CODE> - The <code>header-part</code> of the current <code>encapsulation</code>. <DT><B>Returns:</B><DD>A <code>Map</code> containing the parsed HTTP request headers.</DL> </DD> </DL> <HR> <A NAME="newFileItemHeaders()"><!-- --></A><H3> newFileItemHeaders</H3> <PRE> protected <A HREF="../../../../org/apache/commons/fileupload/util/FileItemHeadersImpl.html" title="class in org.apache.commons.fileupload.util">FileItemHeadersImpl</A> <B>newFileItemHeaders</B>()</PRE> <DL> <DD>Creates a new instance of <A HREF="../../../../org/apache/commons/fileupload/FileItemHeaders.html" title="interface in org.apache.commons.fileupload"><CODE>FileItemHeaders</CODE></A>. <P> <DD><DL> <DT><B>Returns:</B><DD>The new instance.</DL> </DD> </DL> <HR> <A NAME="parseHeaders(java.lang.String)"><!-- --></A><H3> parseHeaders</H3> <PRE> protected java.util.Map <B>parseHeaders</B>(java.lang.String headerPart)</PRE> <DL> <DD><B>Deprecated.</B> <I>Use <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.html#getParsedHeaders(java.lang.String)"><CODE>getParsedHeaders(String)</CODE></A></I> <P> <DD><p> Parses the <code>header-part</code> and returns as key/value pairs. <p> If there are multiple headers of the same names, the name will map to a comma-separated list containing the values. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>headerPart</CODE> - The <code>header-part</code> of the current <code>encapsulation</code>. <DT><B>Returns:</B><DD>A <code>Map</code> containing the parsed HTTP request headers.</DL> </DD> </DL> <HR> <A NAME="parseEndOfLine(java.lang.String, int)"><!-- --></A><H3> parseEndOfLine</H3> <PRE> private int <B>parseEndOfLine</B>(java.lang.String headerPart, int end)</PRE> <DL> <DD>Skips bytes until the end of the current line. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>headerPart</CODE> - The headers, which are being parsed.<DD><CODE>end</CODE> - Index of the last byte, which has yet been processed. <DT><B>Returns:</B><DD>Index of the \r\n sequence, which indicates end of line.</DL> </DD> </DL> <HR> <A NAME="parseHeaderLine(org.apache.commons.fileupload.util.FileItemHeadersImpl, java.lang.String)"><!-- --></A><H3> parseHeaderLine</H3> <PRE> private void <B>parseHeaderLine</B>(<A HREF="../../../../org/apache/commons/fileupload/util/FileItemHeadersImpl.html" title="class in org.apache.commons.fileupload.util">FileItemHeadersImpl</A> headers, java.lang.String header)</PRE> <DL> <DD>Reads the next header line. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>headers</CODE> - String with all headers.<DD><CODE>header</CODE> - Map where to store the current header.</DL> </DD> </DL> <HR> <A NAME="getHeader(java.util.Map, java.lang.String)"><!-- --></A><H3> getHeader</H3> <PRE> protected final java.lang.String <B>getHeader</B>(java.util.Map headers, java.lang.String name)</PRE> <DL> <DD><B>Deprecated.</B> <I>Use <A HREF="../../../../org/apache/commons/fileupload/FileItemHeaders.html#getHeader(java.lang.String)"><CODE>FileItemHeaders.getHeader(String)</CODE></A>.</I> <P> <DD>Returns the header with the specified name from the supplied map. The header lookup is case-insensitive. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>headers</CODE> - A <code>Map</code> containing the HTTP request headers.<DD><CODE>name</CODE> - The name of the header to return. <DT><B>Returns:</B><DD>The value of specified header, or a comma-separated list if there were multiple headers of that name.</DL> </DD> </DL> <HR> <A NAME="getProgressListener()"><!-- --></A><H3> getProgressListener</H3> <PRE> public <A HREF="../../../../org/apache/commons/fileupload/ProgressListener.html" title="interface in org.apache.commons.fileupload">ProgressListener</A> <B>getProgressListener</B>()</PRE> <DL> <DD>Returns the progress listener. <P> <DD><DL> <DT><B>Returns:</B><DD>The progress listener, if any, or null.</DL> </DD> </DL> <HR> <A NAME="setProgressListener(org.apache.commons.fileupload.ProgressListener)"><!-- --></A><H3> setProgressListener</H3> <PRE> public void <B>setProgressListener</B>(<A HREF="../../../../org/apache/commons/fileupload/ProgressListener.html" title="interface in org.apache.commons.fileupload">ProgressListener</A> pListener)</PRE> <DL> <DD>Sets the progress listener. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>pListener</CODE> - The progress listener, if any. Defaults to null.</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FileUploadBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../org/apache/commons/fileupload/FileUpload.html" title="class in org.apache.commons.fileupload"><B>PREV CLASS</B></A> <A HREF="../../../../org/apache/commons/fileupload/FileUploadBase.FileItemIteratorImpl.html" title="class in org.apache.commons.fileupload"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?org/apache/commons/fileupload/FileUploadBase.html" target="_top"><B>FRAMES</B></A> <A HREF="FileUploadBase.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>