| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>UploadService (Fulcrum Upload 1.0.6-SNAPSHOT API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="UploadService (Fulcrum Upload 1.0.6-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/UploadService.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.fulcrum.upload</a></div> |
| <h2 title="Interface UploadService" class="title">Interface UploadService</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="DefaultUploadService.html" title="class in org.apache.fulcrum.upload">DefaultUploadService</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.42">UploadService</a></pre> |
| <div class="block"><p> |
| This service handles parsing <code>multipart/form-data</code> POST requests |
| and turning them into form fields and uploaded files. This can be either |
| performed automatically by the <code>org.apache.fulcrum.parser.ParameterParser</code> or manually by a user |
| defined <code>org.apache.turbine.modules.Action</code>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Id$</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>, <a href="mailto:dlr@collab.net">Daniel Rall</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CONTENT_DISPOSITION">CONTENT_DISPOSITION</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">HTTP header.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CONTENT_TYPE">CONTENT_TYPE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">HTTP header.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#FORM_DATA">FORM_DATA</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">HTTP header base type modifier.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HEADER_ENCODING_DEFAULT">HEADER_ENCODING_DEFAULT</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"> |
| The default value of 'headerEncoding' property (.).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HEADER_ENCODING_KEY">HEADER_ENCODING_KEY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The key in UploadService properties in TurbineResources.properties |
| 'headerEncoding' property.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MIXED">MIXED</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">HTTP header base type modifier.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MULTIPART">MULTIPART</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">HTTP header base type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MULTIPART_FORM_DATA">MULTIPART_FORM_DATA</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">HTTP header.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MULTIPART_MIXED">MULTIPART_MIXED</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">HTTP header.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#REPOSITORY_DEFAULT">REPOSITORY_DEFAULT</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"> |
| The default value of 'repository' property (.).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#REPOSITORY_KEY">REPOSITORY_KEY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The key in UploadService properties in TurbineResources.properties |
| 'repository' property.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#REPOSITORY_PARAMETER">REPOSITORY_PARAMETER</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The request parameter name for overriding 'repository' property (path).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ROLE">ROLE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Avalon Identifier</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SIZE_MAX_DEFAULT">SIZE_MAX_DEFAULT</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"> |
| The default value of 'sizMax' property (1 megabyte = 1048576 bytes).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SIZE_MAX_KEY">SIZE_MAX_KEY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">w The key in UploadService properties in service configuration 'sizeMax' |
| property.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SIZE_THRESHOLD_DEFAULT">SIZE_THRESHOLD_DEFAULT</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"> |
| The default value of 'sizeThreshold' property (10 kilobytes = 10240 bytes).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SIZE_THRESHOLD_KEY">SIZE_THRESHOLD_KEY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The key in UploadService properties in TurbineResources.properties |
| 'sizeThreshold' property.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeaderEncoding()">getHeaderEncoding</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Retrieves the value of the <code>headerEncoding</code> property of |
| <a href="UploadService.html" title="interface in org.apache.fulcrum.upload"><code>UploadService</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>org.apache.commons.fileupload.FileItemIterator</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getItemIterator(javax.portlet.ActionRequest)">getItemIterator</a></span>​(javax.portlet.ActionRequest req)</code></th> |
| <td class="colLast"> |
| <div class="block">Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> |
| compliant <code>multipart/form-data</code> stream.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.apache.commons.fileupload.FileItemIterator</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getItemIterator(javax.servlet.http.HttpServletRequest)">getItemIterator</a></span>​(<a href="https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletRequest</a> req)</code></th> |
| <td class="colLast"> |
| <div class="block">Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> |
| compliant <code>multipart/form-data</code> stream.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRepository()">getRepository</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Retrieves the value of the <code>repository</code> property of |
| <a href="UploadService.html" title="interface in org.apache.fulcrum.upload"><code>UploadService</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSizeMax()">getSizeMax</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Retrieves the value of <code>size.max</code> property of the |
| <a href="UploadService.html" title="interface in org.apache.fulcrum.upload"><code>UploadService</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSizeThreshold()">getSizeThreshold</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Retrieves the value of <code>size.threshold</code> property of |
| <a href="UploadService.html" title="interface in org.apache.fulcrum.upload"><code>UploadService</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMultipart(javax.portlet.ActionRequest)">isMultipart</a></span>​(javax.portlet.ActionRequest req)</code></th> |
| <td class="colLast"> |
| <div class="block">Utility method that determines whether the request contains multipart |
| content.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMultipart(javax.servlet.http.HttpServletRequest)">isMultipart</a></span>​(<a href="https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletRequest</a> req)</code></th> |
| <td class="colLast"> |
| <div class="block">Utility method that determines whether the request contains multipart |
| content.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.apache.commons.fileupload.FileItem></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseRequest(javax.portlet.ActionRequest)">parseRequest</a></span>​(javax.portlet.ActionRequest req)</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant |
| <code>multipart/form-data</code> stream.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.apache.commons.fileupload.FileItem></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseRequest(javax.portlet.ActionRequest,int,int,java.lang.String)">parseRequest</a></span>​(javax.portlet.ActionRequest req, |
| int sizeThreshold, |
| int sizeMax, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path)</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant |
| <code>multipart/form-data</code> stream.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.apache.commons.fileupload.FileItem></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseRequest(javax.portlet.ActionRequest,java.lang.String)">parseRequest</a></span>​(javax.portlet.ActionRequest req, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path)</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant |
| <code>multipart/form-data</code> stream.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.apache.commons.fileupload.FileItem></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseRequest(javax.servlet.http.HttpServletRequest)">parseRequest</a></span>​(<a href="https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletRequest</a> req)</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant |
| <code>multipart/form-data</code> stream.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.apache.commons.fileupload.FileItem></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseRequest(javax.servlet.http.HttpServletRequest,int,int,java.lang.String)">parseRequest</a></span>​(<a href="https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletRequest</a> req, |
| int sizeThreshold, |
| int sizeMax, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path)</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant |
| <code>multipart/form-data</code> stream.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.apache.commons.fileupload.FileItem></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseRequest(javax.servlet.http.HttpServletRequest,java.lang.String)">parseRequest</a></span>​(<a href="https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletRequest</a> req, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path)</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant |
| <code>multipart/form-data</code> stream.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="ROLE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ROLE</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.46">ROLE</a></pre> |
| <div class="block">Avalon Identifier</div> |
| </li> |
| </ul> |
| <a id="CONTENT_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONTENT_TYPE</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.51">CONTENT_TYPE</a></pre> |
| <div class="block">HTTP header.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.CONTENT_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="CONTENT_DISPOSITION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONTENT_DISPOSITION</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.56">CONTENT_DISPOSITION</a></pre> |
| <div class="block">HTTP header.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.CONTENT_DISPOSITION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="MULTIPART"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MULTIPART</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.61">MULTIPART</a></pre> |
| <div class="block">HTTP header base type.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.MULTIPART">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="FORM_DATA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FORM_DATA</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.66">FORM_DATA</a></pre> |
| <div class="block">HTTP header base type modifier.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.FORM_DATA">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="MIXED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MIXED</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.71">MIXED</a></pre> |
| <div class="block">HTTP header base type modifier.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.MIXED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="MULTIPART_FORM_DATA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MULTIPART_FORM_DATA</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.76">MULTIPART_FORM_DATA</a></pre> |
| <div class="block">HTTP header.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.MULTIPART_FORM_DATA">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="MULTIPART_MIXED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MULTIPART_MIXED</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.81">MULTIPART_MIXED</a></pre> |
| <div class="block">HTTP header.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.MULTIPART_MIXED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="REPOSITORY_PARAMETER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REPOSITORY_PARAMETER</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.86">REPOSITORY_PARAMETER</a></pre> |
| <div class="block">The request parameter name for overriding 'repository' property (path).</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.REPOSITORY_PARAMETER">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="REPOSITORY_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REPOSITORY_KEY</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.92">REPOSITORY_KEY</a></pre> |
| <div class="block">The key in UploadService properties in TurbineResources.properties |
| 'repository' property.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.REPOSITORY_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="REPOSITORY_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REPOSITORY_DEFAULT</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.100">REPOSITORY_DEFAULT</a></pre> |
| <div class="block"><p> |
| The default value of 'repository' property (.). This is the directory where |
| uploaded files will get stored temporarily. Note that "." is whatever the |
| servlet container chooses to be it's 'current directory'.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.REPOSITORY_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="SIZE_MAX_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SIZE_MAX_KEY</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.106">SIZE_MAX_KEY</a></pre> |
| <div class="block">w The key in UploadService properties in service configuration 'sizeMax' |
| property.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.SIZE_MAX_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="SIZE_MAX_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SIZE_MAX_DEFAULT</h4> |
| <pre>static final int <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.116">SIZE_MAX_DEFAULT</a></pre> |
| <div class="block"><p> |
| The default value of 'sizMax' property (1 megabyte = 1048576 bytes). This is |
| the maximum size of POST request that will be parsed by the uploader. If you |
| need to set specific limits for your users, set this property to the largest |
| limit value, and use an action + no auto upload to enforce limits.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.SIZE_MAX_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="SIZE_THRESHOLD_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SIZE_THRESHOLD_KEY</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.122">SIZE_THRESHOLD_KEY</a></pre> |
| <div class="block">The key in UploadService properties in TurbineResources.properties |
| 'sizeThreshold' property.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.SIZE_THRESHOLD_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="SIZE_THRESHOLD_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SIZE_THRESHOLD_DEFAULT</h4> |
| <pre>static final int <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.130">SIZE_THRESHOLD_DEFAULT</a></pre> |
| <div class="block"><p> |
| The default value of 'sizeThreshold' property (10 kilobytes = 10240 bytes). |
| This is the maximum size of a POST request that will have it's components |
| stored temporarily in memory, instead of disk.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.SIZE_THRESHOLD_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="HEADER_ENCODING_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HEADER_ENCODING_KEY</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.136">HEADER_ENCODING_KEY</a></pre> |
| <div class="block">The key in UploadService properties in TurbineResources.properties |
| 'headerEncoding' property.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.HEADER_ENCODING_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="HEADER_ENCODING_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HEADER_ENCODING_DEFAULT</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.143">HEADER_ENCODING_DEFAULT</a></pre> |
| <div class="block"><p> |
| The default value of 'headerEncoding' property (.). The value has been |
| decided by copying from DiskFileItem class</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.fulcrum.upload.UploadService.HEADER_ENCODING_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="parseRequest(javax.servlet.http.HttpServletRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseRequest</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.apache.commons.fileupload.FileItem> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.156">parseRequest</a>​(<a href="https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletRequest</a> req) |
| throws org.apache.avalon.framework.service.ServiceException</pre> |
| <div class="block"><p> |
| Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant |
| <code>multipart/form-data</code> stream. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - The servlet request to be parsed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of file items</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.avalon.framework.service.ServiceException</code> - Problems reading/parsing the request or storing |
| the uploaded file(s).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="parseRequest(javax.servlet.http.HttpServletRequest,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseRequest</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.apache.commons.fileupload.FileItem> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.170">parseRequest</a>​(<a href="https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletRequest</a> req, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path) |
| throws org.apache.avalon.framework.service.ServiceException</pre> |
| <div class="block"><p> |
| Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant |
| <code>multipart/form-data</code> stream. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - The servlet request to be parsed.</dd> |
| <dd><code>path</code> - The location where the files should be stored.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of FileItem parts</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.avalon.framework.service.ServiceException</code> - Problems reading/parsing the request or storing |
| the uploaded file(s).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="parseRequest(javax.servlet.http.HttpServletRequest,int,int,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseRequest</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.apache.commons.fileupload.FileItem> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.186">parseRequest</a>​(<a href="https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletRequest</a> req, |
| int sizeThreshold, |
| int sizeMax, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path) |
| throws org.apache.avalon.framework.service.ServiceException</pre> |
| <div class="block"><p> |
| Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant |
| <code>multipart/form-data</code> stream. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - The servlet request to be parsed.</dd> |
| <dd><code>sizeThreshold</code> - the max size in bytes to be stored in memory</dd> |
| <dd><code>sizeMax</code> - the maximum allowed upload size in bytes</dd> |
| <dd><code>path</code> - The location where the files should be stored.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of FileItem parts</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.avalon.framework.service.ServiceException</code> - Problems reading/parsing the request or storing |
| the uploaded file(s).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getItemIterator(javax.servlet.http.HttpServletRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getItemIterator</h4> |
| <pre class="methodSignature">org.apache.commons.fileupload.FileItemIterator <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.203">getItemIterator</a>​(<a href="https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletRequest</a> req) |
| throws org.apache.avalon.framework.service.ServiceException</pre> |
| <div class="block">Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> |
| compliant <code>multipart/form-data</code> stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - The servlet request to be parsed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An iterator to instances of <code>FileItemStream</code> parsed from |
| the request, in the order that they were transmitted.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.avalon.framework.service.ServiceException</code> - if there are problems reading/parsing the request or |
| storing files. This may also be a network error |
| while communicating with the client or a problem |
| while storing the uploaded content.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="parseRequest(javax.portlet.ActionRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseRequest</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.apache.commons.fileupload.FileItem> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.216">parseRequest</a>​(javax.portlet.ActionRequest req) |
| throws org.apache.avalon.framework.service.ServiceException</pre> |
| <div class="block"><p> |
| Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant |
| <code>multipart/form-data</code> stream. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - The portlet request to be parsed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of FileItem parts</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.avalon.framework.service.ServiceException</code> - Problems reading/parsing the request or storing |
| the uploaded file(s).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="parseRequest(javax.portlet.ActionRequest,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseRequest</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.apache.commons.fileupload.FileItem> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.230">parseRequest</a>​(javax.portlet.ActionRequest req, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path) |
| throws org.apache.avalon.framework.service.ServiceException</pre> |
| <div class="block"><p> |
| Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant |
| <code>multipart/form-data</code> stream. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - The portlet request to be parsed.</dd> |
| <dd><code>path</code> - The location where the files should be stored.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of FileItem parts</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.avalon.framework.service.ServiceException</code> - Problems reading/parsing the request or storing |
| the uploaded file(s).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="parseRequest(javax.portlet.ActionRequest,int,int,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseRequest</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.apache.commons.fileupload.FileItem> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.246">parseRequest</a>​(javax.portlet.ActionRequest req, |
| int sizeThreshold, |
| int sizeMax, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path) |
| throws org.apache.avalon.framework.service.ServiceException</pre> |
| <div class="block"><p> |
| Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant |
| <code>multipart/form-data</code> stream. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - The portlet request to be parsed.</dd> |
| <dd><code>sizeThreshold</code> - the max size in bytes to be stored in memory</dd> |
| <dd><code>sizeMax</code> - the maximum allowed upload size in bytes</dd> |
| <dd><code>path</code> - The location where the files should be stored.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The list of FileItem parts uploaded</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.avalon.framework.service.ServiceException</code> - Problems reading/parsing the request or storing |
| the uploaded file(s).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getItemIterator(javax.portlet.ActionRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getItemIterator</h4> |
| <pre class="methodSignature">org.apache.commons.fileupload.FileItemIterator <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.262">getItemIterator</a>​(javax.portlet.ActionRequest req) |
| throws org.apache.avalon.framework.service.ServiceException</pre> |
| <div class="block">Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> |
| compliant <code>multipart/form-data</code> stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - The portlet request to be parsed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An iterator to instances of <code>FileItemStream</code> parsed from |
| the request, in the order that they were transmitted.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.avalon.framework.service.ServiceException</code> - if there are problems reading/parsing the request or |
| storing files. This may also be a network error |
| while communicating with the client or a problem |
| while storing the uploaded content.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSizeMax()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSizeMax</h4> |
| <pre class="methodSignature">long <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.271">getSizeMax</a>()</pre> |
| <div class="block"><p> |
| Retrieves the value of <code>size.max</code> property of the |
| <a href="UploadService.html" title="interface in org.apache.fulcrum.upload"><code>UploadService</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The maximum upload size.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSizeThreshold()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSizeThreshold</h4> |
| <pre class="methodSignature">long <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.280">getSizeThreshold</a>()</pre> |
| <div class="block"><p> |
| Retrieves the value of <code>size.threshold</code> property of |
| <a href="UploadService.html" title="interface in org.apache.fulcrum.upload"><code>UploadService</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The threshold beyond which files are written directly to disk.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRepository()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRepository</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.289">getRepository</a>()</pre> |
| <div class="block"><p> |
| Retrieves the value of the <code>repository</code> property of |
| <a href="UploadService.html" title="interface in org.apache.fulcrum.upload"><code>UploadService</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The repository.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHeaderEncoding()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaderEncoding</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.298">getHeaderEncoding</a>()</pre> |
| <div class="block"><p> |
| Retrieves the value of the <code>headerEncoding</code> property of |
| <a href="UploadService.html" title="interface in org.apache.fulcrum.upload"><code>UploadService</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the headerEncoding.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isMultipart(javax.servlet.http.HttpServletRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMultipart</h4> |
| <pre class="methodSignature">boolean <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.309">isMultipart</a>​(<a href="https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletRequest</a> req)</pre> |
| <div class="block">Utility method that determines whether the request contains multipart |
| content.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - The servlet request to be evaluated. Must be non-null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the request is multipart; <code>false</code> |
| otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isMultipart(javax.portlet.ActionRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isMultipart</h4> |
| <pre class="methodSignature">boolean <a href="../../../../src-html/org/apache/fulcrum/upload/UploadService.html#line.320">isMultipart</a>​(javax.portlet.ActionRequest req)</pre> |
| <div class="block">Utility method that determines whether the request contains multipart |
| content.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - The portlet request to be evaluated. Must be non-null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the request is multipart; <code>false</code> |
| otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/UploadService.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2005–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |