source/mir/session/UploadedFile.java

   1 /*
   2  * Copyright (C) 2001-2006 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License,
  22  * and distribute linked combinations including the two.  You must obey the
  23  * GNU General Public License in all respects for all of the code used other than
  24  * the above mentioned libraries.  If you modify this file, you may extend this
  25  * exception to your version of the file, but you are not obligated to do so.
  26  * If you do not wish to do so, delete this exception statement from your version.
  27  */
  28 package mir.session;
  29
  30 import java.io.File;
  31 import java.io.InputStream;
  32 import java.io.OutputStream;
  33
  34 public interface UploadedFile {
  35   /**
  36    * Writes the uploaded content to a file
  37    */
  38   public void writeToFile(File aFile) throws SessionExc, SessionFailure;
  39
  40   /**
  41    * Writes the uploaded content to a file
  42    */
  43   public void writeToStream(OutputStream aStream) throws SessionExc, SessionFailure;
  44
  45   /**
  46    * Creates an <code>InputStream</code> to access the uploaded content
  47    */
  48   public InputStream getInputStream() throws SessionExc, SessionFailure;
  49
  50   /**
  51    * Return the filename supplied by the uploader if available.
  52    * <code>null</code> if no filename is available.
  53    */
  54   public String getFileName();
  55
  56   /**
  57    * Return the field name associated with the uploaded file
  58    */
  59   public String getFieldName();
  60
  61   /**
  62    * Return the content type (if it's present) of the uploaded file.
  63    * <code>null</code> if no content type is available.
  64    */
  65   public String getContentType();
  66 }