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.entity.HttpEntityWrapper;
36 import org.apache.http.nio.ContentDecoder;
37 import org.apache.http.nio.IOControl;
38 import org.apache.http.nio.protocol.BasicAsyncRequestConsumer;
39 import org.apache.http.nio.protocol.BasicAsyncResponseConsumer;
40
41 /**
42 * A {@link ConsumingNHttpEntity} that forwards available content to a
43 * {@link ContentListener}.
44 *
45 * @since 4.0
46 *
47 * @deprecated (4.2) use {@link BasicAsyncRequestConsumer} or {@link BasicAsyncResponseConsumer}
48 */
49 @Deprecated
50 public class ConsumingNHttpEntityTemplate
51 extends HttpEntityWrapper implements ConsumingNHttpEntity {
52
53 private final ContentListener contentListener;
54
55 public ConsumingNHttpEntityTemplate(
56 final HttpEntity httpEntity,
57 final ContentListener contentListener) {
58 super(httpEntity);
59 this.contentListener = contentListener;
60 }
61
62 public ContentListener getContentListener() {
63 return contentListener;
64 }
65
66 @Override
67 public InputStream getContent() throws IOException, UnsupportedOperationException {
68 throw new UnsupportedOperationException("Does not support blocking methods");
69 }
70
71 @Override
72 public boolean isStreaming() {
73 return true;
74 }
75
76 @Override
77 public void writeTo(OutputStream out) throws IOException, UnsupportedOperationException {
78 throw new UnsupportedOperationException("Does not support blocking methods");
79 }
80
81 /**
82 * This method is equivalent to the {@link #finish()} method.
83 * <br/>
84 * TODO: The name of this method is misnomer. It will be renamed to
85 * #finish() in the next major release.
86 */
87 @Override
88 public void consumeContent() throws IOException {
89 finish();
90 }
91
92 public void consumeContent(
93 final ContentDecoder decoder,
94 final IOControl ioctrl) throws IOException {
95 this.contentListener.contentAvailable(decoder, ioctrl);
96 }
97
98 public void finish() {
99 this.contentListener.finished();
100 }
101
102 }