/**
    * This file Copyright (c) 2003-2014 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.cms.beans.runtime;
  
  import org.apache.commons.io.IOUtils;
  import org.apache.commons.lang.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import java.io.FileInputStream;
  import java.io.FileNotFoundException;
  import java.io.InputStream;
  import java.io.Serializable;
  
  
  /**
   * A wrapper for a temporary uploaded file.
   *
   * User: sameercharles Date: Apr 28, 2003 Time: 11:20:59 AM
   * @author Sameer Charles
   * @version 1.1
   */
  public class Document implements Serializable {
      private static final Logger log = LoggerFactory.getLogger(Document.class);
  
      /**
       * Generated id.
       */
      private static final long serialVersionUID = -1183373762999086707L;
  
  
      /**
       * request parameter name.
       */
      private String atomName;
  
      /**
       * File name, without extension.
       */
      private String fileName;
  
      /**
       * File extension.
       */
      private String extension;
  
      /**
       * Mime type.
       */
      private String type;
  
      /**
       * Underlying file.
       */
      private java.io.File file;
  
      /**
       * A reference to the file input stream.
       */
      transient private FileInputStream inputStream;
  
      /**
       * package private constructor.
       */
      Document() {
      }
  
      /**
      * Used to create a document based on a existing file.
      */
     public Document(java.io.File file, String type) {
         String fileName = file.getName();
         this.setFile(file);
         this.setType(type);
         this.setExtension(StringUtils.substringAfterLast(fileName, "."));
         this.setFileName(StringUtils.substringBeforeLast(fileName, "."));
     }
 
     /**
      * Sets the parameter name.
      * @param name parameter name
      */
     public void setAtomName(String name) {
         this.atomName = name;
     }
 
     /**
      * Returns the parameter name.
      * @return parameter name
      */
     public String getAtomName() {
         return this.atomName;
     }
 
     /**
      * Sets the file name without extension.
      * @param name file name without extension
      */
     public void setFileName(String name) {
         this.fileName = name;
     }
 
     /**
      * Returns the file name without extension.
      * @return file name
      */
     public String getFileName() {
         return this.fileName;
     }
 
     /**
      * Returns the full file name with extension (if existing).
      * @return file name with extension
      */
     public String getFileNameWithExtension() {
         if (StringUtils.isEmpty(this.extension)) {
             return this.fileName;
         }
 
         return this.fileName + "." + this.extension; //$NON-NLS-1$
     }
 
     /**
      * Sets the mime type for this file.
      * @param type mime type
      */
     public void setType(String type) {
         this.type = type;
     }
 
     /**
      * Returns the mime type for this file.
      * @return mime type
      */
     public String getType() {
         return this.type;
     }
 
     /**
      * Sets a reference to the uploaded file.
      * @param in file
      */
     public void setFile(java.io.File in) {
         this.file = in;
     }
 
     /**
      * Sets the file extension.
      * @param ext file extension
      * @deprecated since 4.1.1 typo in method name - use setExtension  instead
      */
     public void setExtention(String ext) {
         setExtension(ext);
     }
 
     public void setExtension(String ext) {
         this.extension = ext;
     }
 
     /**
      * Returns the file extension.
      * @return file extension
      */
     public String getExtension() {
         return this.extension;
     }
 
     /**
      * Returns the file length in bytes.
      * @return file length
      */
     public long getLength() {
         return this.file.length();
     }
 
     /**
      * Returns a stream from the uploaded file. Note that subsequent invocation will always return a reference to the
      * same input stream.
      * @return stream from the uploaded file
      */
     public InputStream getStream() {
         try {
             return (this.inputStream = (new FileInputStream(this.file)));
         }
         catch (FileNotFoundException e) {
             log.error("Failed to locate file {}" + this.file.getAbsolutePath());
             return null;
         }
     }
 
     /**
      * Returns the uploaded file. Users should normally use getStream, but getFile() can be used when you need to
      * repeatedly access the file. <strong>The obtained file should never be deleted by the caller</strong>
      * @return a reference to the uploaded file.
      */
     public java.io.File getFile() {
         return this.file;
     }
 
     /**
      * Delete the file, taking care of closing an open input stream.
      */
     public void delete() {
         IOUtils.closeQuietly(inputStream);
         this.file.delete();
     }
 }