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.http.nio.entity;
29  
30  import java.io.IOException;
31  import java.io.InputStream;
32  import java.io.OutputStream;
33  
34  import org.apache.http.HttpEntity;
35  import org.apache.http.annotation.NotThreadSafe;
36  import org.apache.http.entity.HttpEntityWrapper;
37  import org.apache.http.nio.ContentDecoder;
38  import org.apache.http.nio.IOControl;
39  import org.apache.http.nio.protocol.BasicAsyncRequestConsumer;
40  import org.apache.http.nio.protocol.BasicAsyncResponseConsumer;
41  import org.apache.http.nio.util.ByteBufferAllocator;
42  import org.apache.http.nio.util.SimpleInputBuffer;
43  
44  /**
45   * A {@link ConsumingNHttpEntity} that consumes content into a buffer. The
46   * content can be retrieved as an InputStream via
47   * {@link HttpEntity#getContent()}, or written to an output stream via
48   * {@link HttpEntity#writeTo(OutputStream)}.
49   *
50   * @since 4.0
51   *
52   * @deprecated (4.2) use {@link BasicAsyncRequestConsumer} or {@link BasicAsyncResponseConsumer}
53   */
54  @NotThreadSafe
55  @Deprecated
56  public class BufferingNHttpEntity extends HttpEntityWrapper implements
57          ConsumingNHttpEntity {
58  
59      private final static int BUFFER_SIZE = 2048;
60  
61      private final SimpleInputBuffer buffer;
62      private boolean finished;
63      private boolean consumed;
64  
65      public BufferingNHttpEntity(
66              final HttpEntity httpEntity,
67              final ByteBufferAllocator allocator) {
68          super(httpEntity);
69          this.buffer = new SimpleInputBuffer(BUFFER_SIZE, allocator);
70      }
71  
72      public void consumeContent(
73              final ContentDecoder decoder,
74              final IOControl ioctrl) throws IOException {
75          this.buffer.consumeContent(decoder);
76          if (decoder.isCompleted()) {
77              this.finished = true;
78          }
79      }
80  
81      public void finish() {
82          this.finished = true;
83      }
84  
85      @Override
86      public void consumeContent() throws IOException {
87      }
88  
89      /**
90       * Obtains entity's content as {@link InputStream}.
91       *
92       *  @throws IllegalStateException if content of the entity has not been
93       *    fully received or has already been consumed.
94       */
95      @Override
96      public InputStream getContent() throws IOException {
97          if (!this.finished) {
98              throw new IllegalStateException("Entity content has not been fully received");
99          }
100         if (this.consumed) {
101             throw new IllegalStateException("Entity content has been consumed");
102         }
103         this.consumed = true;
104         return new ContentInputStream(this.buffer);
105     }
106 
107     @Override
108     public boolean isRepeatable() {
109         return false;
110     }
111 
112     @Override
113     public boolean isStreaming() {
114         return true;
115     }
116 
117     @Override
118     public void writeTo(final OutputStream outstream) throws IOException {
119         if (outstream == null) {
120             throw new IllegalArgumentException("Output stream may not be null");
121         }
122         InputStream instream = getContent();
123         byte[] buffer = new byte[BUFFER_SIZE];
124         int l;
125         // consume until EOF
126         while ((l = instream.read(buffer)) != -1) {
127             outstream.write(buffer, 0, l);
128         }
129     }
130 
131 }