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.IOException;
31  import java.io.InputStream;
32  import java.nio.file.Files;
33  import java.nio.file.Path;
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 path.
42   */
43  @Contract(threading = ThreadingBehavior.IMMUTABLE_CONDITIONAL)
44  public class PathEntity extends AbstractHttpEntity {
45  
46      private final Path path;
47  
48      public PathEntity(final Path path, final ContentType contentType, final String contentEncoding) {
49          super(contentType, contentEncoding);
50          this.path = Args.notNull(path, "Path");
51      }
52  
53      public PathEntity(final Path path, final ContentType contentType) {
54          super(contentType, null);
55          this.path = Args.notNull(path, "Path");
56      }
57  
58      @Override
59      public final boolean isRepeatable() {
60          return true;
61      }
62  
63      @Override
64      public final long getContentLength() {
65          try {
66              return Files.size(this.path);
67          } catch (final IOException e) {
68              throw new IllegalStateException(e);
69          }
70      }
71  
72      @Override
73      public final InputStream getContent() throws IOException {
74          return Files.newInputStream(path);
75      }
76  
77      @Override
78      public final boolean isStreaming() {
79          return false;
80      }
81  
82      @Override
83      public final void close() throws IOException {
84          // do nothing
85      }
86  
87  }