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  
33  import org.apache.hc.core5.annotation.Contract;
34  import org.apache.hc.core5.annotation.ThreadingBehavior;
35  import org.apache.hc.core5.http.ContentType;
36  import org.apache.hc.core5.io.Closer;
37  import org.apache.hc.core5.util.Args;
38  
39  /**
40   * A generic streamed, non-repeatable entity that obtains its content from an {@link InputStream}.
41   *
42   * @since 4.0
43   */
44  @Contract(threading = ThreadingBehavior.IMMUTABLE_CONDITIONAL)
45  public class BasicHttpEntity extends AbstractHttpEntity {
46  
47      private final InputStream content;
48      private final long length;
49  
50      public BasicHttpEntity(
51              final InputStream content, final long length, final ContentType contentType, final String contentEncoding,
52              final boolean chunked) {
53          super(contentType, contentEncoding, chunked);
54          this.content = Args.notNull(content, "Content stream");
55          this.length = length;
56      }
57  
58      public BasicHttpEntity(
59              final InputStream content, final long length, final ContentType contentType, final String contentEncoding) {
60          this(content, length, contentType, contentEncoding, false);
61      }
62  
63      public BasicHttpEntity(final InputStream content, final long length, final ContentType contentType) {
64          this(content, length, contentType, null);
65      }
66  
67      public BasicHttpEntity(final InputStream content, final ContentType contentType, final String contentEncoding) {
68          this(content, -1, contentType, contentEncoding);
69      }
70  
71      public BasicHttpEntity(final InputStream content, final ContentType contentType) {
72          this(content, -1, contentType, null);
73      }
74  
75      public BasicHttpEntity(final InputStream content, final ContentType contentType, final boolean chunked) {
76          this(content, -1, contentType, null, chunked);
77      }
78  
79      @Override
80      public final long getContentLength() {
81          return this.length;
82      }
83  
84      @Override
85      public final InputStream getContent() throws IllegalStateException {
86          return this.content;
87      }
88  
89      @Override
90      public final boolean isRepeatable() {
91          return false;
92      }
93  
94      @Override
95      public final boolean isStreaming() {
96          return this.content != null && this.content != EmptyInputStream.INSTANCE;
97      }
98  
99      @Override
100     public final void close() throws IOException {
101         Closer.close(content);
102     }
103 
104 }