| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Fri Aug 22 03:43:58 EDT 2003 --> |
| <TITLE> |
| DiskMultipartRequestHandler (Apache Struts API Documentation) |
| </TITLE> |
| <META NAME="keywords" CONTENT="org.apache.struts.upload.DiskMultipartRequestHandler,DiskMultipartRequestHandler class"> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <SCRIPT> |
| function asd() |
| { |
| parent.document.title="DiskMultipartRequestHandler (Apache Struts API Documentation)"; |
| } |
| </SCRIPT> |
| <BODY BGCOLOR="white" onload="asd();"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <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/DiskMultipartRequestHandler.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/struts/upload/DiskFile.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/upload/MultipartBoundaryInputStream.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> |
| <A HREF="DiskMultipartRequestHandler.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <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: NESTED | <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> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.struts.upload</FONT> |
| <BR> |
| Class DiskMultipartRequestHandler</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<B>org.apache.struts.upload.DiskMultipartRequestHandler</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public class <B>DiskMultipartRequestHandler</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></DL> |
| |
| <P> |
| This is a MultipartRequestHandler that writes file data directly to |
| to temporary files on disk. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Mike Schachter</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.Hashtable</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#allElements">allElements</A></B></CODE> |
| |
| <BR> |
| A Hashtable representing all elemnents.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.Hashtable</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#fileElements">fileElements</A></B></CODE> |
| |
| <BR> |
| A Hashtable representing the form files uploaded.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static org.apache.commons.logging.Log</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#log">log</A></B></CODE> |
| |
| <BR> |
| Commons Logging instance.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#mapping">mapping</A></B></CODE> |
| |
| <BR> |
| The ActionMapping instance used for this class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#servlet">servlet</A></B></CODE> |
| |
| <BR> |
| The ActionServlet instance used for this class.</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/struts/upload/DiskMultipartRequestHandler.html#tempDir">tempDir</A></B></CODE> |
| |
| <BR> |
| The temporary directory.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.Hashtable</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#textElements">textElements</A></B></CODE> |
| |
| <BR> |
| A Hashtable representing the form text input names and values.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.struts.upload.MultipartRequestHandler"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Fields inherited from interface org.apache.struts.upload.<A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#ATTRIBUTE_MAX_LENGTH_EXCEEDED">ATTRIBUTE_MAX_LENGTH_EXCEEDED</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#DiskMultipartRequestHandler()">DiskMultipartRequestHandler</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#createDiskFile(org.apache.struts.upload.MultipartElement)">createDiskFile</A></B>(<A HREF="../../../../org/apache/struts/upload/MultipartElement.html">MultipartElement</A> element)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#createTextElement(javax.servlet.http.HttpServletRequest, org.apache.struts.upload.MultipartElement)">createTextElement</A></B>(javax.servlet.http.HttpServletRequest request, |
| <A HREF="../../../../org/apache/struts/upload/MultipartElement.html">MultipartElement</A> element)</CODE> |
| |
| <BR> |
| </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/struts/upload/DiskMultipartRequestHandler.html#finish()">finish</A></B>()</CODE> |
| |
| <BR> |
| Calls on <A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#rollback()"><CODE>rollback()</CODE></A> to delete |
| temporary files.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Hashtable</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#getAllElements()">getAllElements</A></B>()</CODE> |
| |
| <BR> |
| This method returns all elements of a multipart request.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Hashtable</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#getFileElements()">getFileElements</A></B>()</CODE> |
| |
| <BR> |
| This method is called on to retrieve all the FormFile |
| input elements of the request.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#getMapping()">getMapping</A></B>()</CODE> |
| |
| <BR> |
| Get the ActionMapping instance for this request</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#getMaxSize(java.lang.String)">getMaxSize</A></B>(java.lang.String stringSize)</CODE> |
| |
| <BR> |
| Gets the maximum post data size in bytes from the string |
| representation in the configuration file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#getServlet()">getServlet</A></B>()</CODE> |
| |
| <BR> |
| Get the ActionServlet instance</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Hashtable</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#getTextElements()">getTextElements</A></B>()</CODE> |
| |
| <BR> |
| This method is called on to retrieve all the text |
| input elements of the request.</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/struts/upload/DiskMultipartRequestHandler.html#handleRequest(javax.servlet.http.HttpServletRequest)">handleRequest</A></B>(javax.servlet.http.HttpServletRequest request)</CODE> |
| |
| <BR> |
| This method populates the internal hashtables with multipart request data.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#retrieveTempDir(org.apache.struts.config.ModuleConfig)">retrieveTempDir</A></B>(<A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> moduleConfig)</CODE> |
| |
| <BR> |
| Retrieves the temporary directory from either ActionServlet, a context |
| property, or a system property, in that order.</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/struts/upload/DiskMultipartRequestHandler.html#rollback()">rollback</A></B>()</CODE> |
| |
| <BR> |
| Delete all the files uploaded.</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/struts/upload/DiskMultipartRequestHandler.html#setMapping(org.apache.struts.action.ActionMapping)">setMapping</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping)</CODE> |
| |
| <BR> |
| Convienience method to set a reference to a working |
| ActionMapping instance.</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/struts/upload/DiskMultipartRequestHandler.html#setServlet(org.apache.struts.action.ActionServlet)">setServlet</A></B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet)</CODE> |
| |
| <BR> |
| Convienience method to set a reference to a working |
| ActionServlet instance.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </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" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="log"><!-- --></A><H3> |
| log</H3> |
| <PRE> |
| protected static org.apache.commons.logging.Log <B>log</B></PRE> |
| <DL> |
| <DD>Commons Logging instance. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="servlet"><!-- --></A><H3> |
| servlet</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> <B>servlet</B></PRE> |
| <DL> |
| <DD>The ActionServlet instance used for this class. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="mapping"><!-- --></A><H3> |
| mapping</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> <B>mapping</B></PRE> |
| <DL> |
| <DD>The ActionMapping instance used for this class. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="fileElements"><!-- --></A><H3> |
| fileElements</H3> |
| <PRE> |
| protected java.util.Hashtable <B>fileElements</B></PRE> |
| <DL> |
| <DD>A Hashtable representing the form files uploaded. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="textElements"><!-- --></A><H3> |
| textElements</H3> |
| <PRE> |
| protected java.util.Hashtable <B>textElements</B></PRE> |
| <DL> |
| <DD>A Hashtable representing the form text input names and values. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="allElements"><!-- --></A><H3> |
| allElements</H3> |
| <PRE> |
| protected java.util.Hashtable <B>allElements</B></PRE> |
| <DL> |
| <DD>A Hashtable representing all elemnents. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="tempDir"><!-- --></A><H3> |
| tempDir</H3> |
| <PRE> |
| protected java.lang.String <B>tempDir</B></PRE> |
| <DL> |
| <DD>The temporary directory. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="DiskMultipartRequestHandler()"><!-- --></A><H3> |
| DiskMultipartRequestHandler</H3> |
| <PRE> |
| public <B>DiskMultipartRequestHandler</B>()</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="handleRequest(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> |
| handleRequest</H3> |
| <PRE> |
| public void <B>handleRequest</B>(javax.servlet.http.HttpServletRequest request) |
| throws javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>This method populates the internal hashtables with multipart request data. |
| If the request argument is an instance of MultipartRequestWrapper, |
| the request wrapper will be populated as well. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#handleRequest(javax.servlet.http.HttpServletRequest)">handleRequest</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.servlet.ServletException</CODE> - thrown if something goes wrong</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createTextElement(javax.servlet.http.HttpServletRequest, org.apache.struts.upload.MultipartElement)"><!-- --></A><H3> |
| createTextElement</H3> |
| <PRE> |
| protected void <B>createTextElement</B>(javax.servlet.http.HttpServletRequest request, |
| <A HREF="../../../../org/apache/struts/upload/MultipartElement.html">MultipartElement</A> element)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createDiskFile(org.apache.struts.upload.MultipartElement)"><!-- --></A><H3> |
| createDiskFile</H3> |
| <PRE> |
| protected void <B>createDiskFile</B>(<A HREF="../../../../org/apache/struts/upload/MultipartElement.html">MultipartElement</A> element)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAllElements()"><!-- --></A><H3> |
| getAllElements</H3> |
| <PRE> |
| public java.util.Hashtable <B>getAllElements</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD> |
| <DD>This method returns all elements of a multipart request. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getAllElements()">getAllElements</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>A Hashtable where the keys are input names and values |
| are either Strings or FormFiles</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTextElements()"><!-- --></A><H3> |
| getTextElements</H3> |
| <PRE> |
| public java.util.Hashtable <B>getTextElements</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD> |
| <DD>This method is called on to retrieve all the text |
| input elements of the request. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getTextElements()">getTextElements</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>A Hashtable where the keys and values are the names and |
| values of the request input parameters</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFileElements()"><!-- --></A><H3> |
| getFileElements</H3> |
| <PRE> |
| public java.util.Hashtable <B>getFileElements</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD> |
| <DD>This method is called on to retrieve all the FormFile |
| input elements of the request. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getFileElements()">getFileElements</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>A Hashtable where the keys are the input names of the |
| files and the values are FormFile objects<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/struts/upload/FormFile.html"><CODE>FormFile</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="rollback()"><!-- --></A><H3> |
| rollback</H3> |
| <PRE> |
| public void <B>rollback</B>()</PRE> |
| <DL> |
| <DD>Delete all the files uploaded. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#rollback()">rollback</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="finish()"><!-- --></A><H3> |
| finish</H3> |
| <PRE> |
| public void <B>finish</B>()</PRE> |
| <DL> |
| <DD>Calls on <A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html#rollback()"><CODE>rollback()</CODE></A> to delete |
| temporary files. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#finish()">finish</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setServlet(org.apache.struts.action.ActionServlet)"><!-- --></A><H3> |
| setServlet</H3> |
| <PRE> |
| public void <B>setServlet</B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD> |
| <DD>Convienience method to set a reference to a working |
| ActionServlet instance. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#setServlet(org.apache.struts.action.ActionServlet)">setServlet</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setMapping(org.apache.struts.action.ActionMapping)"><!-- --></A><H3> |
| setMapping</H3> |
| <PRE> |
| public void <B>setMapping</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD> |
| <DD>Convienience method to set a reference to a working |
| ActionMapping instance. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#setMapping(org.apache.struts.action.ActionMapping)">setMapping</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getServlet()"><!-- --></A><H3> |
| getServlet</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> <B>getServlet</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD> |
| <DD>Get the ActionServlet instance |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getServlet()">getServlet</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMapping()"><!-- --></A><H3> |
| getMapping</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> <B>getMapping</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></B></DD> |
| <DD>Get the ActionMapping instance for this request |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getMapping()">getMapping</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMaxSize(java.lang.String)"><!-- --></A><H3> |
| getMaxSize</H3> |
| <PRE> |
| protected long <B>getMaxSize</B>(java.lang.String stringSize) |
| throws javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Gets the maximum post data size in bytes from the string |
| representation in the configuration file. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DD><CODE>javax.servlet.ServletException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="retrieveTempDir(org.apache.struts.config.ModuleConfig)"><!-- --></A><H3> |
| retrieveTempDir</H3> |
| <PRE> |
| protected void <B>retrieveTempDir</B>(<A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> moduleConfig)</PRE> |
| <DL> |
| <DD>Retrieves the temporary directory from either ActionServlet, a context |
| property, or a system property, in that order. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </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="../../../../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/DiskMultipartRequestHandler.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/struts/upload/DiskFile.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/upload/MultipartBoundaryInputStream.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> |
| <A HREF="DiskMultipartRequestHandler.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <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: NESTED | <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> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2000-2003 - Apache Software Foundation |
| </BODY> |
| </HTML> |
