1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.http.entity;
29
30 import java.io.File;
31 import java.io.FileInputStream;
32 import java.io.IOException;
33 import java.io.InputStream;
34 import java.io.OutputStream;
35
36 import org.apache.http.annotation.NotThreadSafe;
37
38 /**
39 * A self contained, repeatable entity that obtains its content from a file.
40 *
41 * @since 4.0
42 */
43 @NotThreadSafe
44 public class FileEntity extends AbstractHttpEntity implements Cloneable {
45
46 protected final File file;
47
48 /**
49 * @deprecated (4.1.3) {@link #FileEntity(File, ContentType)}
50 */
51 @Deprecated
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 /**
62 * @since 4.2
63 */
64 public FileEntity(final File file, final ContentType contentType) {
65 super();
66 if (file == null) {
67 throw new IllegalArgumentException("File may not be null");
68 }
69 this.file = file;
70 if (contentType != null) {
71 setContentType(contentType.toString());
72 }
73 }
74
75 /**
76 * @since 4.2
77 */
78 public FileEntity(final File file) {
79 super();
80 if (file == null) {
81 throw new IllegalArgumentException("File may not be null");
82 }
83 this.file = file;
84 }
85
86 public boolean isRepeatable() {
87 return true;
88 }
89
90 public long getContentLength() {
91 return this.file.length();
92 }
93
94 public InputStream getContent() throws IOException {
95 return new FileInputStream(this.file);
96 }
97
98 public void writeTo(final OutputStream outstream) throws IOException {
99 if (outstream == null) {
100 throw new IllegalArgumentException("Output stream may not be null");
101 }
102 InputStream instream = new FileInputStream(this.file);
103 try {
104 byte[] tmp = new byte[4096];
105 int l;
106 while ((l = instream.read(tmp)) != -1) {
107 outstream.write(tmp, 0, l);
108 }
109 outstream.flush();
110 } finally {
111 instream.close();
112 }
113 }
114
115 /**
116 * Tells that this entity is not streaming.
117 *
118 * @return <code>false</code>
119 */
120 public boolean isStreaming() {
121 return false;
122 }
123
124 @Override
125 public Object clone() throws CloneNotSupportedException {
126 // File instance is considered immutable
127 // No need to make a copy of it
128 return super.clone();
129 }
130
131 } // class FileEntity