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.hc.core5.http.io.entity;
29
30 import java.io.File;
31 import java.io.FileInputStream;
32 import java.io.IOException;
33 import java.io.InputStream;
34
35 import org.apache.hc.core5.annotation.Contract;
36 import org.apache.hc.core5.annotation.ThreadingBehavior;
37 import org.apache.hc.core5.http.ContentType;
38 import org.apache.hc.core5.util.Args;
39
40 /**
41 * A self contained, repeatable entity that obtains its content from a file.
42 *
43 * @since 4.0
44 */
45 @Contract(threading = ThreadingBehavior.IMMUTABLE_CONDITIONAL)
46 public class FileEntity extends AbstractHttpEntity {
47
48 private final File file;
49
50 public FileEntity(final File file, final ContentType contentType, final String contentEncoding) {
51 super(contentType, contentEncoding);
52 this.file = Args.notNull(file, "File");
53 }
54
55 public FileEntity(final File file, final ContentType contentType) {
56 super(contentType, null);
57 this.file = Args.notNull(file, "File");
58 }
59
60 @Override
61 public final boolean isRepeatable() {
62 return true;
63 }
64
65 @Override
66 public final long getContentLength() {
67 return this.file.length();
68 }
69
70 @Override
71 public final InputStream getContent() throws IOException {
72 return new FileInputStream(this.file);
73 }
74
75 @Override
76 public final boolean isStreaming() {
77 return false;
78 }
79
80 @Override
81 public final void close() throws IOException {
82 // do nothing
83 }
84
85 }