You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by si...@apache.org on 2013/03/05 22:53:02 UTC
svn commit: r1453029 - in
/commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload:
./ disk/ portlet/ servlet/ util/
Author: simonetripodi
Date: Tue Mar 5 21:53:01 2013
New Revision: 1453029
URL: http://svn.apache.org/r1453029
Log:
[FILEUPLOAD-220] #comment package.html replaced with package-info.java #resolve
Added:
commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/disk/package-info.java (with props)
commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/package-info.java (with props)
commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/portlet/package-info.java (with props)
commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/servlet/package-info.java (with props)
commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/package-info.java (with props)
Removed:
commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/disk/package.html
commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/package.html
commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/portlet/package.html
commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/servlet/package.html
commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/package.html
Added: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/disk/package-info.java
URL: http://svn.apache.org/viewvc/commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/disk/package-info.java?rev=1453029&view=auto
==============================================================================
--- commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/disk/package-info.java (added)
+++ commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/disk/package-info.java Tue Mar 5 21:53:01 2013
@@ -0,0 +1,54 @@
+/**
+ * <p>
+ * A disk-based implementation of the
+ * {@link org.apache.commons.fileupload.FileItem FileItem}
+ * interface. This implementation retains smaller items in memory, while
+ * writing larger ones to disk. The threshold between these two is
+ * configurable, as is the location of files that are written to disk.
+ * </p>
+ * <p>
+ * In typical usage, an instance of
+ * {@link org.apache.commons.fileupload.disk.DiskFileItemFactory DiskFileItemFactory}
+ * would be created, configured, and then passed to a
+ * {@link org.apache.commons.fileupload.FileUpload FileUpload}
+ * implementation such as
+ * {@link org.apache.commons.fileupload.servlet.ServletFileUpload ServletFileUpload}
+ * or
+ * {@link org.apache.commons.fileupload.portlet.PortletFileUpload PortletFileUpload}.
+ * </p>
+ * <p>
+ * The following code fragment demonstrates this usage.
+ * </p>
+ * <pre>
+ * DiskFileItemFactory factory = new DiskFileItemFactory();
+ * // maximum size that will be stored in memory
+ * factory.setSizeThreshold(4096);
+ * // the location for saving data that is larger than getSizeThreshold()
+ * factory.setRepository(new File("/tmp"));
+ *
+ * ServletFileUpload upload = new ServletFileUpload(factory);
+ * </pre>
+ * <p>
+ * Please see the FileUpload
+ * <a href="http://commons.apache.org/fileupload/using.html" target="_top">User Guide</a>
+ * for further details and examples of how to use this package.
+ * </p>
+ */
+package org.apache.commons.fileupload.disk;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/disk/package-info.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/disk/package-info.java
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/disk/package-info.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/package-info.java
URL: http://svn.apache.org/viewvc/commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/package-info.java?rev=1453029&view=auto
==============================================================================
--- commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/package-info.java (added)
+++ commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/package-info.java Tue Mar 5 21:53:01 2013
@@ -0,0 +1,85 @@
+/**
+ * <p>
+ * A component for handling HTML file uploads as specified by
+ * <a href="http://www.ietf.org/rfc/rfc1867.txt" target="_top">RFC 1867</a>.
+ * This component provides support for uploads within both servlets (JSR 53)
+ * and portlets (JSR 168).
+ * </p>
+ * <p>
+ * While this package provides the generic functionality for file uploads,
+ * these classes are not typically used directly. Instead, normal usage
+ * involves one of the provided extensions of
+ * {@link org.apache.commons.fileupload.FileUpload FileUpload} such as
+ * {@link org.apache.commons.fileupload.servlet.ServletFileUpload ServletFileUpload}
+ * or
+ * {@link org.apache.commons.fileupload.portlet.PortletFileUpload PortletFileUpload},
+ * together with a factory for
+ * {@link org.apache.commons.fileupload.FileItem FileItem} instances,
+ * such as
+ * {@link org.apache.commons.fileupload.disk.DiskFileItemFactory DiskFileItemFactory}.
+ * </p>
+ * <p>
+ * The following is a brief example of typical usage in a servlet, storing
+ * the uploaded files on disk.
+ * </p>
+ * <pre>public void doPost(HttpServletRequest req, HttpServletResponse res) {
+ * DiskFileItemFactory factory = new DiskFileItemFactory();
+ * // maximum size that will be stored in memory
+ * factory.setSizeThreshold(4096);
+ * // the location for saving data that is larger than getSizeThreshold()
+ * factory.setRepository(new File("/tmp"));
+ *
+ * ServletFileUpload upload = new ServletFileUpload(factory);
+ * // maximum size before a FileUploadException will be thrown
+ * upload.setSizeMax(1000000);
+ *
+ * List fileItems = upload.parseRequest(req);
+ * // assume we know there are two files. The first file is a small
+ * // text file, the second is unknown and is written to a file on
+ * // the server
+ * Iterator i = fileItems.iterator();
+ * String comment = ((FileItem)i.next()).getString();
+ * FileItem fi = (FileItem)i.next();
+ * // filename on the client
+ * String fileName = fi.getName();
+ * // save comment and filename to database
+ * ...
+ * // write the file
+ * fi.write(new File("/www/uploads/", fileName));
+ * }
+ * </pre>
+ * <p>
+ * In the example above, the first file is loaded into memory as a
+ * <code>String</code>. Before calling the <code>getString</code> method,
+ * the data may have been in memory or on disk depending on its size. The
+ * second file we assume it will be large and therefore never explicitly
+ * load it into memory, though if it is less than 4096 bytes it will be
+ * in memory before it is written to its final location. When writing to
+ * the final location, if the data is larger than the threshold, an attempt
+ * is made to rename the temporary file to the given location. If it cannot
+ * be renamed, it is streamed to the new location.
+ * </p>
+ * <p>
+ * Please see the FileUpload
+ * <a href="http://commons.apache.org/fileupload/using.html" target="_top">User Guide</a>
+ * for further details and examples of how to use this package.
+ * </p>
+ */
+package org.apache.commons.fileupload;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/package-info.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/package-info.java
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/package-info.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/portlet/package-info.java
URL: http://svn.apache.org/viewvc/commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/portlet/package-info.java?rev=1453029&view=auto
==============================================================================
--- commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/portlet/package-info.java (added)
+++ commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/portlet/package-info.java Tue Mar 5 21:53:01 2013
@@ -0,0 +1,45 @@
+/**
+ * <p>
+ * An implementation of
+ * {@link org.apache.commons.fileupload.FileUpload FileUpload}
+ * for use in portlets conforming to JSR 168. This implementation requires
+ * only access to the portlet's current <code>ActionRequest</code> instance,
+ * and a suitable
+ * {@link org.apache.commons.fileupload.FileItemFactory FileItemFactory}
+ * implementation, such as
+ * {@link org.apache.commons.fileupload.disk.DiskFileItemFactory DiskFileItemFactory}.
+ * </p>
+ * <p>
+ * The following code fragment demonstrates typical usage.
+ * </p>
+ * <pre>
+ * DiskFileItemFactory factory = new DiskFileItemFactory();
+ * // Configure the factory here, if desired.
+ * PortletFileUpload upload = new PortletFileUpload(factory);
+ * // Configure the uploader here, if desired.
+ * List fileItems = upload.parseRequest(request);
+ * </pre>
+ * <p>
+ * Please see the FileUpload
+ * <a href="http://commons.apache.org/fileupload/using.html" target="_top">User Guide</a>
+ * for further details and examples of how to use this package.
+ * </p>
+ */
+package org.apache.commons.fileupload.portlet;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/portlet/package-info.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/portlet/package-info.java
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/portlet/package-info.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/servlet/package-info.java
URL: http://svn.apache.org/viewvc/commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/servlet/package-info.java?rev=1453029&view=auto
==============================================================================
--- commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/servlet/package-info.java (added)
+++ commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/servlet/package-info.java Tue Mar 5 21:53:01 2013
@@ -0,0 +1,45 @@
+/**
+ * <p>
+ * An implementation of
+ * {@link org.apache.commons.fileupload.FileUpload FileUpload}
+ * for use in servlets conforming to JSR 53. This implementation requires
+ * only access to the servlet's current <code>HttpServletRequest</code>
+ * instance, and a suitable
+ * {@link org.apache.commons.fileupload.FileItemFactory FileItemFactory}
+ * implementation, such as
+ * {@link org.apache.commons.fileupload.disk.DiskFileItemFactory DiskFileItemFactory}.
+ * </p>
+ * <p>
+ * The following code fragment demonstrates typical usage.
+ * </p>
+ * <pre>
+ * DiskFileItemFactory factory = new DiskFileItemFactory();
+ * // Configure the factory here, if desired.
+ * ServletFileUpload upload = new ServletFileUpload(factory);
+ * // Configure the uploader here, if desired.
+ * List fileItems = upload.parseRequest(request);
+ * </pre>
+ * <p>
+ * Please see the FileUpload
+ * <a href="http://commons.apache.org/fileupload/using.html" target="_top">User Guide</a>
+ * for further details and examples of how to use this package.
+ * </p>
+ */
+package org.apache.commons.fileupload.servlet;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/servlet/package-info.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/servlet/package-info.java
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/servlet/package-info.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/package-info.java
URL: http://svn.apache.org/viewvc/commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/package-info.java?rev=1453029&view=auto
==============================================================================
--- commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/package-info.java (added)
+++ commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/package-info.java Tue Mar 5 21:53:01 2013
@@ -0,0 +1,23 @@
+/**
+ * This package contains various IO related utility classes
+ * or methods, which are basically reusable and not necessarily
+ * restricted to the scope of a file upload.
+ */
+package org.apache.commons.fileupload.util;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/package-info.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/package-info.java
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/package-info.java
------------------------------------------------------------------------------
svn:mime-type = text/plain