View Javadoc
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.http.ContentType;
36  import org.apache.hc.core5.util.Args;
37  
38  /**
39   * A self contained, repeatable entity that obtains its content from a file.
40   *
41   * @since 4.0
42   */
43  public class FileEntity extends AbstractHttpEntity {
44  
45      private final File file;
46  
47      /**
48       * Creates a new instance.
49       *
50       * @param file The file to serve.
51       * @param contentType  The content type for the given {@code file}.
52       *
53       * @since 4.2
54       */
55      public FileEntity(final File file, final ContentType contentType) {
56          super();
57          this.file = Args.notNull(file, "File");
58          if (contentType != null) {
59              setContentType(contentType.toString());
60          }
61      }
62  
63      /**
64       * Creates a new instance.
65       *
66       * @param file The file to serve.
67       *
68       * @since 4.2
69       */
70      public FileEntity(final File file) {
71          super();
72          this.file = Args.notNull(file, "File");
73      }
74  
75      @Override
76      public boolean isRepeatable() {
77          return true;
78      }
79  
80      @Override
81      public long getContentLength() {
82          return this.file.length();
83      }
84  
85      @Override
86      public InputStream getContent() throws IOException {
87          return new FileInputStream(this.file);
88      }
89  
90      /**
91       * Tells that this entity is not streaming.
92       *
93       * @return {@code false}
94       */
95      @Override
96      public boolean isStreaming() {
97          return false;
98      }
99  
100     @Override
101     public void close() throws IOException {
102         // do nothing
103     }
104 
105 }