Home » HttpComponents-Core-4.0.1 » org.apache.http.entity » [javadoc | source]

    1   /*
    2    * $HeadURL: https://svn.apache.org/repos/asf/httpcomponents/httpcore/tags/4.0.1/httpcore/src/main/java/org/apache/http/entity/FileEntity.java $
    3    * $Revision: 744523 $
    4    * $Date: 2009-02-14 17:57:41 +0100 (Sat, 14 Feb 2009) $
    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    * A self contained, repeatable entity that obtains its content from a file.
   42    *
   43    *
   44    * @version $Revision: 744523 $
   45    * 
   46    * @since 4.0
   47    */
   48   public class FileEntity extends AbstractHttpEntity implements Cloneable {
   49   
   50       protected final File file; 
   51   
   52       public FileEntity(final File file, final String contentType) {
   53           super();
   54           if (file == null) {
   55               throw new IllegalArgumentException("File may not be null");
   56           }
   57           this.file = file;
   58           setContentType(contentType);
   59       }
   60   
   61       public boolean isRepeatable() {
   62           return true;
   63       }
   64   
   65       public long getContentLength() {
   66           return this.file.length();
   67       }
   68       
   69       public InputStream getContent() throws IOException {
   70           return new FileInputStream(this.file);
   71       }
   72       
   73       public void writeTo(final OutputStream outstream) throws IOException {
   74           if (outstream == null) {
   75               throw new IllegalArgumentException("Output stream may not be null");
   76           }
   77           InputStream instream = new FileInputStream(this.file);
   78           try {
   79               byte[] tmp = new byte[4096];
   80               int l;
   81               while ((l = instream.read(tmp)) != -1) {
   82                   outstream.write(tmp, 0, l);
   83               }
   84               outstream.flush();
   85           } finally {
   86               instream.close();
   87           }
   88       }
   89   
   90       /**
   91        * Tells that this entity is not streaming.
   92        *
   93        * @return <code>false</code>
   94        */
   95       public boolean isStreaming() {
   96           return false;
   97       }
   98   
   99       public Object clone() throws CloneNotSupportedException {
  100           // File instance is considered immutable
  101           // No need to make a copy of it
  102           return super.clone();
  103       }
  104   
  105   } // class FileEntity

Home » HttpComponents-Core-4.0.1 » org.apache.http.entity » [javadoc | source]