| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>DefaultUploadService (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="DefaultUploadService (Fulcrum Upload 1.0.6-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/DefaultUploadService.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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="Class DefaultUploadService" class="title">Class DefaultUploadService</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.avalon.framework.logger.AbstractLogEnabled</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.fulcrum.upload.DefaultUploadService</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>org.apache.avalon.framework.activity.Initializable</code>, <code>org.apache.avalon.framework.configuration.Configurable</code>, <code>org.apache.avalon.framework.context.Contextualizable</code>, <code>org.apache.avalon.framework.logger.LogEnabled</code>, <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <a href="../../../../src-html/org/apache/fulcrum/upload/DefaultUploadService.html#line.67">DefaultUploadService</a> |
| extends org.apache.avalon.framework.logger.AbstractLogEnabled |
| implements <a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a>, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.context.Contextualizable</pre> |
| <div class="block"><p> |
| This class is an implementation of <a href="UploadService.html" title="interface in org.apache.fulcrum.upload"><code>UploadService</code></a>. |
| |
| <p> |
| Files will be stored in temporary disk storage on in memory, depending on |
| request size, and will be available from the |
| <code>org.apache.fulcrum.util.parser.ParameterParser</code> as |
| <code>org.apache.commons.fileupload.FileItem</code> objects. |
| |
| <p> |
| This implementation of <a href="UploadService.html" title="interface in org.apache.fulcrum.upload"><code>UploadService</code></a> handles multiple files per |
| single html form, sent using multipart/form-data encoding type, as specified |
| by RFC 1867. Use |
| <code>org.apache.fulcrum.parser.ParameterParser#getFileItems(String)</code> to |
| acquire an array of <code>org.apache.commons.fileupload.FileItem</code> objects |
| associated with given html form.</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>, <a href="mailto:jvanzyl@apache.org">Jason van Zyl</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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.fulcrum.upload.UploadService"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.fulcrum.upload.<a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></h3> |
| <code><a href="UploadService.html#CONTENT_DISPOSITION">CONTENT_DISPOSITION</a>, <a href="UploadService.html#CONTENT_TYPE">CONTENT_TYPE</a>, <a href="UploadService.html#FORM_DATA">FORM_DATA</a>, <a href="UploadService.html#HEADER_ENCODING_DEFAULT">HEADER_ENCODING_DEFAULT</a>, <a href="UploadService.html#HEADER_ENCODING_KEY">HEADER_ENCODING_KEY</a>, <a href="UploadService.html#MIXED">MIXED</a>, <a href="UploadService.html#MULTIPART">MULTIPART</a>, <a href="UploadService.html#MULTIPART_FORM_DATA">MULTIPART_FORM_DATA</a>, <a href="UploadService.html#MULTIPART_MIXED">MULTIPART_MIXED</a>, <a href="UploadService.html#REPOSITORY_DEFAULT">REPOSITORY_DEFAULT</a>, <a href="UploadService.html#REPOSITORY_KEY">REPOSITORY_KEY</a>, <a href="UploadService.html#REPOSITORY_PARAMETER">REPOSITORY_PARAMETER</a>, <a href="UploadService.html#ROLE">ROLE</a>, <a href="UploadService.html#SIZE_MAX_DEFAULT">SIZE_MAX_DEFAULT</a>, <a href="UploadService.html#SIZE_MAX_KEY">SIZE_MAX_KEY</a>, <a href="UploadService.html#SIZE_THRESHOLD_DEFAULT">SIZE_THRESHOLD_DEFAULT</a>, <a href="UploadService.html#SIZE_THRESHOLD_KEY">SIZE_THRESHOLD_KEY</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">DefaultUploadService</a></span>()</code></th> |
| <td class="colLast"> </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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configure(org.apache.avalon.framework.configuration.Configuration)">configure</a></span>​(org.apache.avalon.framework.configuration.Configuration conf)</code></th> |
| <td class="colLast"> |
| <div class="block">Avalon component lifecycle method</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contextualize(org.apache.avalon.framework.context.Context)">contextualize</a></span>​(org.apache.avalon.framework.context.Context context)</code></th> |
| <td class="colLast"> |
| <div class="block">Avalon component lifecycle method</div> |
| </td> |
| </tr> |
| <tr id="i2" 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="i3" 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="i4" 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="i5" 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">The location used to temporarily store files that are larger than the size |
| threshold.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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">The maximum allowed upload size</div> |
| </td> |
| </tr> |
| <tr id="i7" 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">The threshold beyond which files are written directly to disk.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize()">initialize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Avalon component lifecycle method |
| |
| Initializes the service.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <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="i10" class="altColor"> |
| <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="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.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="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.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="i13" class="rowColor"> |
| <td class="colFirst"><code>protected <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,org.apache.commons.fileupload.disk.DiskFileItemFactory)">parseRequest</a></span>​(javax.portlet.ActionRequest req, |
| int sizeMax, |
| org.apache.commons.fileupload.disk.DiskFileItemFactory factory)</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="i14" 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="i15" 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="i16" 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="i17" class="rowColor"> |
| <td class="colFirst"><code>protected <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,org.apache.commons.fileupload.disk.DiskFileItemFactory)">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 sizeMax, |
| org.apache.commons.fileupload.disk.DiskFileItemFactory factory)</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="i18" 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,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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.avalon.framework.logger.AbstractLogEnabled"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled</h3> |
| <code>enableLogging, getLogger, setupLogger, setupLogger, setupLogger</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultUploadService</h4> |
| <pre>public <a href="../../../../src-html/org/apache/fulcrum/upload/DefaultUploadService.html#line.67">DefaultUploadService</a>()</pre> |
| </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="getSizeMax()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSizeMax</h4> |
| <pre class="methodSignature">public long <a href="../../../../src-html/org/apache/fulcrum/upload/DefaultUploadService.html#line.86">getSizeMax</a>()</pre> |
| <div class="block">The maximum allowed upload size</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#getSizeMax()">getSizeMax</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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">public long <a href="../../../../src-html/org/apache/fulcrum/upload/DefaultUploadService.html#line.94">getSizeThreshold</a>()</pre> |
| <div class="block">The threshold beyond which files are written directly to disk.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#getSizeThreshold()">getSizeThreshold</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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">public <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/DefaultUploadService.html#line.103">getRepository</a>()</pre> |
| <div class="block">The location used to temporarily store files that are larger than the size |
| threshold.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#getRepository()">getRepository</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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">public <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/DefaultUploadService.html#line.111">getHeaderEncoding</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="UploadService.html#getHeaderEncoding()">UploadService</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#getHeaderEncoding()">getHeaderEncoding</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the headerEncoding.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="parseRequest(javax.servlet.http.HttpServletRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseRequest</h4> |
| <pre class="methodSignature">public <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/DefaultUploadService.html#line.126">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#parseRequest(javax.servlet.http.HttpServletRequest)">parseRequest</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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">public <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/DefaultUploadService.html#line.142">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#parseRequest(javax.servlet.http.HttpServletRequest,java.lang.String)">parseRequest</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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">public <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/DefaultUploadService.html#line.161">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#parseRequest(javax.servlet.http.HttpServletRequest,int,int,java.lang.String)">parseRequest</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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 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,int,org.apache.commons.fileupload.disk.DiskFileItemFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseRequest</h4> |
| <pre class="methodSignature">protected <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/DefaultUploadService.html#line.180">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 sizeMax, |
| org.apache.commons.fileupload.disk.DiskFileItemFactory factory) |
| 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>sizeMax</code> - the maximum allowed upload size in bytes</dd> |
| <dd><code>factory</code> - the file item factory to use</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="getItemIterator(javax.servlet.http.HttpServletRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getItemIterator</h4> |
| <pre class="methodSignature">public org.apache.commons.fileupload.FileItemIterator <a href="../../../../src-html/org/apache/fulcrum/upload/DefaultUploadService.html#line.206">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#getItemIterator(javax.servlet.http.HttpServletRequest)">getItemIterator</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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">public <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/DefaultUploadService.html#line.228">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#parseRequest(javax.portlet.ActionRequest)">parseRequest</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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">public <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/DefaultUploadService.html#line.244">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#parseRequest(javax.portlet.ActionRequest,java.lang.String)">parseRequest</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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">public <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/DefaultUploadService.html#line.262">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#parseRequest(javax.portlet.ActionRequest,int,int,java.lang.String)">parseRequest</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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="parseRequest(javax.portlet.ActionRequest,int,org.apache.commons.fileupload.disk.DiskFileItemFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseRequest</h4> |
| <pre class="methodSignature">protected <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/DefaultUploadService.html#line.281">parseRequest</a>​(javax.portlet.ActionRequest req, |
| int sizeMax, |
| org.apache.commons.fileupload.disk.DiskFileItemFactory factory) |
| 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>sizeMax</code> - the maximum allowed upload size in bytes</dd> |
| <dd><code>factory</code> - the file item factory to use</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">public org.apache.commons.fileupload.FileItemIterator <a href="../../../../src-html/org/apache/fulcrum/upload/DefaultUploadService.html#line.307">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#getItemIterator(javax.portlet.ActionRequest)">getItemIterator</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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="isMultipart(javax.servlet.http.HttpServletRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMultipart</h4> |
| <pre class="methodSignature">public boolean <a href="../../../../src-html/org/apache/fulcrum/upload/DefaultUploadService.html#line.328">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#isMultipart(javax.servlet.http.HttpServletRequest)">isMultipart</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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="blockList"> |
| <li class="blockList"> |
| <h4>isMultipart</h4> |
| <pre class="methodSignature">public boolean <a href="../../../../src-html/org/apache/fulcrum/upload/DefaultUploadService.html#line.342">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UploadService.html#isMultipart(javax.portlet.ActionRequest)">isMultipart</a></code> in interface <code><a href="UploadService.html" title="interface in org.apache.fulcrum.upload">UploadService</a></code></dd> |
| <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> |
| <a id="configure(org.apache.avalon.framework.configuration.Configuration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configure</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/fulcrum/upload/DefaultUploadService.html#line.365">configure</a>​(org.apache.avalon.framework.configuration.Configuration conf)</pre> |
| <div class="block">Avalon component lifecycle method</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>configure</code> in interface <code>org.apache.avalon.framework.configuration.Configurable</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="initialize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/fulcrum/upload/DefaultUploadService.html#line.385">initialize</a>() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Avalon component lifecycle method |
| |
| Initializes the service. |
| |
| This method processes the repository path, to make it relative to the web |
| application root, if necessary</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>initialize</code> in interface <code>org.apache.avalon.framework.activity.Initializable</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="contextualize(org.apache.avalon.framework.context.Context)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>contextualize</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/fulcrum/upload/DefaultUploadService.html#line.403">contextualize</a>​(org.apache.avalon.framework.context.Context context) |
| throws org.apache.avalon.framework.context.ContextException</pre> |
| <div class="block">Avalon component lifecycle method</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>contextualize</code> in interface <code>org.apache.avalon.framework.context.Contextualizable</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.avalon.framework.context.ContextException</code></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/DefaultUploadService.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
