Home | History | Annotate | Download | only in entity 
      1 /*
      2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/entity/FileEntity.java $
      3  * $Revision: 604625 $
      4  * $Date: 2007-12-16 06:11:11 -0800 (Sun, 16 Dec 2007) $
      5  *
      6  * ====================================================================
      7  * Licensed to the Apache Software Foundation (ASF) under one
      8  * or more contributor license agreements.  See the NOTICE file
      9  * distributed with this work for additional information
     10  * regarding copyright ownership.  The ASF licenses this file
     11  * to you under the Apache License, Version 2.0 (the
     12  * "License"); you may not use this file except in compliance
     13  * with the License.  You may obtain a copy of the License at
     14  *
     15  *   http://www.apache.org/licenses/LICENSE-2.0
     16  *
     17  * Unless required by applicable law or agreed to in writing,
     18  * software distributed under the License is distributed on an
     19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     20  * KIND, either express or implied.  See the License for the
     21  * specific language governing permissions and limitations
     22  * under the License.
     23  * ====================================================================
     24  *
     25  * This software consists of voluntary contributions made by many
     26  * individuals on behalf of the Apache Software Foundation.  For more
     27  * information on the Apache Software Foundation, please see
     28  * <http://www.apache.org/>.
     29  *
     30  */
     31 
     32 package org.apache.http.entity;
     33 
     34 import java.io.File;
     35 import java.io.FileInputStream;
     36 import java.io.IOException;
     37 import java.io.InputStream;
     38 import java.io.OutputStream;
     39 
     40 /**
     41  * An entity whose content is retrieved from a file.
     42  *
     43  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
     44  *
     45  * @version $Revision: 604625 $
     46  *
     47  * @since 4.0
     48  */
     49 public class FileEntity extends AbstractHttpEntity implements Cloneable {
     50 
     51     protected final File file;
     52 
     53     public FileEntity(final File file, final String contentType) {
     54         super();
     55         if (file == null) {
     56             throw new IllegalArgumentException("File may not be null");
     57         }
     58         this.file = file;
     59         setContentType(contentType);
     60     }
     61 
     62     public boolean isRepeatable() {
     63         return true;
     64     }
     65 
     66     public long getContentLength() {
     67         return this.file.length();
     68     }
     69 
     70     public InputStream getContent() throws IOException {
     71         return new FileInputStream(this.file);
     72     }
     73 
     74     public void writeTo(final OutputStream outstream) throws IOException {
     75         if (outstream == null) {
     76             throw new IllegalArgumentException("Output stream may not be null");
     77         }
     78         InputStream instream = new FileInputStream(this.file);
     79         try {
     80             byte[] tmp = new byte[4096];
     81             int l;
     82             while ((l = instream.read(tmp)) != -1) {
     83                 outstream.write(tmp, 0, l);
     84             }
     85             outstream.flush();
     86         } finally {
     87             instream.close();
     88         }
     89     }
     90 
     91     /**
     92      * Tells that this entity is not streaming.
     93      *
     94      * @return <code>false</code>
     95      */
     96     public boolean isStreaming() {
     97         return false;
     98     }
     99 
    100     public Object clone() throws CloneNotSupportedException {
    101         // File instance is considered immutable
    102         // No need to make a copy of it
    103         return super.clone();
    104     }
    105 
    106 } // class FileEntity
    107