michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.entity;
michael@0: 
michael@0: import java.io.File;
michael@0: import java.io.FileInputStream;
michael@0: import java.io.IOException;
michael@0: import java.io.InputStream;
michael@0: import java.io.OutputStream;
michael@0: 
michael@0: /**
michael@0:  * A self contained, repeatable entity that obtains its content from a file.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public class FileEntity extends AbstractHttpEntity implements Cloneable {
michael@0: 
michael@0:     protected final File file;
michael@0: 
michael@0:     public FileEntity(final File file, final String contentType) {
michael@0:         super();
michael@0:         if (file == null) {
michael@0:             throw new IllegalArgumentException("File may not be null");
michael@0:         }
michael@0:         this.file = file;
michael@0:         setContentType(contentType);
michael@0:     }
michael@0: 
michael@0:     public boolean isRepeatable() {
michael@0:         return true;
michael@0:     }
michael@0: 
michael@0:     public long getContentLength() {
michael@0:         return this.file.length();
michael@0:     }
michael@0: 
michael@0:     public InputStream getContent() throws IOException {
michael@0:         return new FileInputStream(this.file);
michael@0:     }
michael@0: 
michael@0:     public void writeTo(final OutputStream outstream) throws IOException {
michael@0:         if (outstream == null) {
michael@0:             throw new IllegalArgumentException("Output stream may not be null");
michael@0:         }
michael@0:         InputStream instream = new FileInputStream(this.file);
michael@0:         try {
michael@0:             byte[] tmp = new byte[4096];
michael@0:             int l;
michael@0:             while ((l = instream.read(tmp)) != -1) {
michael@0:                 outstream.write(tmp, 0, l);
michael@0:             }
michael@0:             outstream.flush();
michael@0:         } finally {
michael@0:             instream.close();
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Tells that this entity is not streaming.
michael@0:      *
michael@0:      * @return <code>false</code>
michael@0:      */
michael@0:     public boolean isStreaming() {
michael@0:         return false;
michael@0:     }
michael@0: 
michael@0:     public Object clone() throws CloneNotSupportedException {
michael@0:         // File instance is considered immutable
michael@0:         // No need to make a copy of it
michael@0:         return super.clone();
michael@0:     }
michael@0: 
michael@0: } // class FileEntity