1. /*
  2. * $Header: /home/cvs/jakarta-commons/fileupload/src/java/org/apache/commons/fileupload/FileUpload.java,v 1.23 2003/06/24 05:45:43 martinc Exp $
  3. * $Revision: 1.23 $
  4. * $Date: 2003/06/24 05:45:43 $
  5. *
  6. * ====================================================================
  7. *
  8. * The Apache Software License, Version 1.1
  9. *
  10. * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
  11. * reserved.
  12. *
  13. * Redistribution and use in source and binary forms, with or without
  14. * modification, are permitted provided that the following conditions
  15. * are met:
  16. *
  17. * 1. Redistributions of source code must retain the above copyright
  18. * notice, this list of conditions and the following disclaimer.
  19. *
  20. * 2. Redistributions in binary form must reproduce the above copyright
  21. * notice, this list of conditions and the following disclaimer in
  22. * the documentation and/or other materials provided with the
  23. * distribution.
  24. *
  25. * 3. The end-user documentation included with the redistribution, if
  26. * any, must include the following acknowlegement:
  27. * "This product includes software developed by the
  28. * Apache Software Foundation (http://www.apache.org/)."
  29. * Alternately, this acknowlegement may appear in the software itself,
  30. * if and wherever such third-party acknowlegements normally appear.
  31. *
  32. * 4. The names "The Jakarta Project", "Commons", and "Apache Software
  33. * Foundation" must not be used to endorse or promote products derived
  34. * from this software without prior written permission. For written
  35. * permission, please contact apache@apache.org.
  36. *
  37. * 5. Products derived from this software may not be called "Apache"
  38. * nor may "Apache" appear in their names without prior written
  39. * permission of the Apache Group.
  40. *
  41. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  42. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  43. * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  44. * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  45. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  46. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  47. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  48. * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  49. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  50. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  51. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52. * SUCH DAMAGE.
  53. * ====================================================================
  54. *
  55. * This software consists of voluntary contributions made by many
  56. * individuals on behalf of the Apache Software Foundation. For more
  57. * information on the Apache Software Foundation, please see
  58. * <http://www.apache.org/>.
  59. *
  60. */
  61. package org.apache.commons.fileupload;
  62. /**
  63. * <p>High level API for processing file uploads.</p>
  64. *
  65. * <p>This class handles multiple files per single HTML widget, sent using
  66. * <code>multipart/mixed</code> encoding type, as specified by
  67. * <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>. Use {@link
  68. * #parseRequest(HttpServletRequest)} to acquire a list of {@link
  69. * org.apache.commons.fileupload.FileItem}s associated with a given HTML
  70. * widget.</p>
  71. *
  72. * <p>How the data for individual parts is stored is determined by the factory
  73. * used to create them; a given part may be in memory, on disk, or somewhere
  74. * else.</p>
  75. *
  76. * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
  77. * @author <a href="mailto:dlr@collab.net">Daniel Rall</a>
  78. * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
  79. * @author <a href="mailto:jmcnally@collab.net">John McNally</a>
  80. * @author <a href="mailto:martinc@apache.org">Martin Cooper</a>
  81. * @author Sean C. Sullivan
  82. *
  83. * @version $Id: FileUpload.java,v 1.23 2003/06/24 05:45:43 martinc Exp $
  84. */
  85. public class FileUpload
  86. extends FileUploadBase
  87. {
  88. // ----------------------------------------------------------- Data members
  89. /**
  90. * The factory to use to create new form items.
  91. */
  92. private FileItemFactory fileItemFactory;
  93. // ----------------------------------------------------------- Constructors
  94. /**
  95. * Constructs an instance of this class which uses the default factory to
  96. * create <code>FileItem</code> instances.
  97. *
  98. * @see #FileUpload(FileItemFactory)
  99. */
  100. public FileUpload()
  101. {
  102. super();
  103. }
  104. /**
  105. * Constructs an instance of this class which uses the supplied factory to
  106. * create <code>FileItem</code> instances.
  107. *
  108. * @see #FileUpload()
  109. */
  110. public FileUpload(FileItemFactory fileItemFactory)
  111. {
  112. super();
  113. this.fileItemFactory = fileItemFactory;
  114. }
  115. // ----------------------------------------------------- Property accessors
  116. /**
  117. * Returns the factory class used when creating file items.
  118. *
  119. * @return The factory class for new file items.
  120. */
  121. public FileItemFactory getFileItemFactory()
  122. {
  123. return fileItemFactory;
  124. }
  125. /**
  126. * Sets the factory class to use when creating file items.
  127. *
  128. * @param factory The factory class for new file items.
  129. */
  130. public void setFileItemFactory(FileItemFactory factory)
  131. {
  132. this.fileItemFactory = factory;
  133. }
  134. }