Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoakim Erdfelt2014-10-06 17:08:12 -0400
committerJoakim Erdfelt2014-10-08 14:02:13 -0400
commiteb39d75f29918c925a4d91d43e0197d509e17f5e (patch)
tree4c6d66df06844be7c2800248bae2279be9cdd859 /jetty-servlets
parent3eb42e7183e70fe68c754edb9cccfc0fc05a5545 (diff)
downloadorg.eclipse.jetty.project-eb39d75f29918c925a4d91d43e0197d509e17f5e.tar.gz
org.eclipse.jetty.project-eb39d75f29918c925a4d91d43e0197d509e17f5e.tar.xz
org.eclipse.jetty.project-eb39d75f29918c925a4d91d43e0197d509e17f5e.zip
Javadoc update
Diffstat (limited to 'jetty-servlets')
-rw-r--r--jetty-servlets/src/main/java/org/eclipse/jetty/servlets/MultiPartFilter.java38
1 files changed, 24 insertions, 14 deletions
diff --git a/jetty-servlets/src/main/java/org/eclipse/jetty/servlets/MultiPartFilter.java b/jetty-servlets/src/main/java/org/eclipse/jetty/servlets/MultiPartFilter.java
index e16e1e8590..c56919187b 100644
--- a/jetty-servlets/src/main/java/org/eclipse/jetty/servlets/MultiPartFilter.java
+++ b/jetty-servlets/src/main/java/org/eclipse/jetty/servlets/MultiPartFilter.java
@@ -60,25 +60,35 @@ import org.eclipse.jetty.util.log.Logger;
/**
* Multipart Form Data Filter.
* <p>
- * This class decodes the multipart/form-data stream sent by a HTML form that uses a file input
+ * This class decodes the <code>multipart/form-data</code> stream sent by a HTML form that uses a file input
* item. Any files sent are stored to a temporary file and a File object added to the request
* as an attribute. All other values are made available via the normal getParameter API and
* the setCharacterEncoding mechanism is respected when converting bytes to Strings.
* <p>
- * If the init parameter "delete" is set to "true", any files created will be deleted when the
- * current request returns.
- * <p>
- * The init parameter maxFormKeys sets the maximum number of keys that may be present in a
- * form (default set by system property org.eclipse.jetty.server.Request.maxFormKeys or 1000) to protect
+ * Init Parameters:
+ * <dl>
+ * <dt>delete</dt>
+ * <dd>(boolean)
+ * If set to "true", any files created will be deleted when the current request returns.</dd>
+ * <dt>maxFormKeys</dt>
+ * <dd>(number)
+ * Sets the maximum number of keys that may be present in a
+ * form (default set by system property <code>org.eclipse.jetty.server.Request.maxFormKeys</code> or 1000) to protect
* against DOS attacks by bad hash keys.
- * <p>
- * The init parameter deleteFiles controls if uploaded files are automatically deleted after the request
- * completes.
- *
- * Use init parameter "maxFileSize" to set the max size file that can be uploaded.
- *
- * Use init parameter "maxRequestSize" to limit the size of the multipart request.
- *
+ * </dd>
+ * <dt>deleteFiles</dt>
+ * <dd>(boolean)
+ * Controls if uploaded files are automatically deleted after the request completes.
+ * </dd>
+ * <dt>maxFileSize</dt>
+ * <dd>(size in bytes)
+ * Set the max size file that can be uploaded.
+ * </dd>
+ * <dt>maxRequestSize</dt>
+ * <dd>(size in bytes)
+ * To limit the size of the multipart request.
+ * </dd>
+ * </dl>
*/
public class MultiPartFilter implements Filter
{

Back to the top