fileuploadbase.html

sss sss sss sss sss sss sz

<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">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">FileItemFactory</A>&nbsp;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 upload size.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The maximum allowed size, in bytes.<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&nbsp;sizeMax)</PRE>
<DL>
<DD>Sets the maximum allowed upload size. If negative, there is no maximum.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sizeMax</CODE> - The maximum allowed size, in bytes, or -1 for no maximum.<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="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 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&nbsp;encoding)</PRE>
<DL>
<DD>Specifies the character encoding to be used when reading the headers of
 individual parts. When 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&nbsp;req)
                            throws <A HREF="../../../../org/apache/commons/fileupload/FileUploadException.html">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. If files are stored
 on disk, the path is given by <code>getRepository()</code>.
<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">FileUploadException</A></CODE> - if there are problems reading/parsing
                                the request or storing files.</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&nbsp;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> - 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="getFieldName(java.util.Map)"><!-- --></A><H3>
getFieldName</H3>
<PRE>
protected java.lang.String <B>getFieldName</B>(java.util.Map&nbsp;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="createItem(java.util.Map, boolean)"><!-- --></A><H3>
createItem</H3>
<PRE>
protected <A HREF="../../../../org/apache/commons/fileupload/FileItem.html">FileItem</A> <B>createItem</B>(java.util.Map&nbsp;headers,
                              boolean&nbsp;isFormField)
                       throws <A HREF="../../../../org/apache/commons/fileupload/FileUploadException.html">FileUploadException</A></PRE>
<DL>
<DD>Creates a new <A HREF="../../../../org/apache/commons/fileupload/FileItem.html"><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">FileUploadException</A></CODE> - if an error occurs.</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&nbsp;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="getHeader(java.util.Map, java.lang.String)"><!-- --></A><H3>
getHeader</H3>
<PRE>
protected final java.lang.String <B>getHeader</B>(java.util.Map&nbsp;headers,
                                           java.lang.String&nbsp;name)</PRE>
<DL>
<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>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FileUploadBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/commons/fileupload/FileUpload.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/commons/fileupload/MultipartStream.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="FileUploadBase.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;
<SCRIPT>
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
Copyright &copy; 2002-2003 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>