/**
 * 이 소스는 Spring 프레임워크 워크북에서 사용한 예제 소스입니다. 
 * 이 소스는 모든 개발자들이 자유롭게 수정 및 배포할 수 있습니다. 
 * 단, 이 소스를 기반으로 새로운 애플리케이션을 개발할 경우 출처를 명시해 주시면 됩니다. 
 */
package net.javajigi.common.upload;

import java.util.Hashtable;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;

/**
 * 주석을 넣어 주세요. 배가 고파요.
 * 
 * @author 박재성(자바지기, javajigi@gmail.com)
 */
public interface MultipartRequestHandler {
    /**
     * After constructed, this is the first method called on
     * by ActionServlet.  Use this method for all your
     * data-parsing of the ServletInputStream in the request
     *
     * @exception ServletException thrown if something goes wrong
     */
   public void handleRequest(HttpServletRequest request)
       throws ServletException;

   /**
    * This method is called on to retrieve all the text
    * input elements of the request.
    *
    * @return A Hashtable where the keys and values are the names and
    *  values of the request input parameters
    */
   public Hashtable getTextElements();
   
   /**
    * This method is called on to retrieve all the FormFile
    * input elements of the request.
    * @see org.apache.struts.upload.FormFile
    * @return A Hashtable where the keys are the input names of the
    *  files and the values are FormFile objects
    */
   public Hashtable getFileElements();

   /**
    * This method returns all elements of a multipart request.
    * @return A Hashtable where the keys are input names and values
    *   are either Strings or FormFiles
    */
   public Hashtable getAllElements();

   /**
    * This method is called on when there's some sort of problem
    * and the form post needs to be rolled back.  Providers
    * should remove any FormFiles used to hold information
    * by setting them to null and also physically delete
    * them if the implementation calls for writing directly
    * to disk.
    * NOTE: Currently implemented but not automatically
    * supported, ActionForm implementors must call rollback()
    * manually for rolling back file uploads.
    */
   public void rollback();

   /**
    * This method is called on when a successful form post
    * has been made.  Some implementations will use this
    * to destroy temporary files or write to a database
    * or something of that nature.
    */
   public void finish();
}