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  * @deprecated Please use {@link java.net.URL#openConnection} instead.
50  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
51  *     for further details.
52  */
53 @Deprecated
54 public class FileEntity extends AbstractHttpEntity implements Cloneable {
55 
56     protected final File file;
57 
FileEntity(final File file, final String contentType)58     public FileEntity(final File file, final String contentType) {
59         super();
60         if (file == null) {
61             throw new IllegalArgumentException("File may not be null");
62         }
63         this.file = file;
64         setContentType(contentType);
65     }
66 
isRepeatable()67     public boolean isRepeatable() {
68         return true;
69     }
70 
getContentLength()71     public long getContentLength() {
72         return this.file.length();
73     }
74 
getContent()75     public InputStream getContent() throws IOException {
76         return new FileInputStream(this.file);
77     }
78 
writeTo(final OutputStream outstream)79     public void writeTo(final OutputStream outstream) throws IOException {
80         if (outstream == null) {
81             throw new IllegalArgumentException("Output stream may not be null");
82         }
83         InputStream instream = new FileInputStream(this.file);
84         try {
85             byte[] tmp = new byte[4096];
86             int l;
87             while ((l = instream.read(tmp)) != -1) {
88                 outstream.write(tmp, 0, l);
89             }
90             outstream.flush();
91         } finally {
92             instream.close();
93         }
94     }
95 
96     /**
97      * Tells that this entity is not streaming.
98      *
99      * @return <code>false</code>
100      */
isStreaming()101     public boolean isStreaming() {
102         return false;
103     }
104 
clone()105     public Object clone() throws CloneNotSupportedException {
106         // File instance is considered immutable
107         // No need to make a copy of it
108         return super.clone();
109     }
110 
111 } // class FileEntity
112