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 package org.apache.hc.client5.http.async.methods;
28
29 import java.io.IOException;
30 import java.io.UnsupportedEncodingException;
31 import java.nio.charset.Charset;
32 import java.nio.charset.StandardCharsets;
33 import java.nio.charset.UnsupportedCharsetException;
34
35 import org.apache.hc.core5.http.ContentType;
36 import org.apache.hc.core5.http.EntityDetails;
37 import org.apache.hc.core5.http.HttpException;
38 import org.apache.hc.core5.http.HttpRequest;
39 import org.apache.hc.core5.http.HttpResponse;
40 import org.apache.hc.core5.http.nio.AsyncPushConsumer;
41 import org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer;
42 import org.apache.hc.core5.http.protocol.HttpContext;
43
44 /**
45 * Abstract push response consumer that processes response body data as a character stream.
46 *
47 * @since 5.0
48 */
49 public abstract class AbstractCharPushConsumer extends AbstractCharDataConsumer implements AsyncPushConsumer {
50
51 /**
52 * Triggered to signal the beginning of data processing.
53 *
54 * @param response the response message head
55 * @param contentType the content type of the response body,
56 * or {@code null} if the response does not enclose a response entity.
57 */
58 protected abstract void start(HttpRequest promise, HttpResponse response, ContentType contentType) throws HttpException, IOException;
59
60 @Override
61 public final void consumePromise(
62 final HttpRequest promise,
63 final HttpResponse response,
64 final EntityDetails entityDetails,
65 final HttpContext context) throws HttpException, IOException {
66 if (entityDetails != null) {
67 final ContentType contentType;
68 try {
69 contentType = ContentType.parse(entityDetails.getContentType());
70 } catch (final UnsupportedCharsetException ex) {
71 throw new UnsupportedEncodingException(ex.getMessage());
72 }
73 Charset charset = contentType != null ? contentType.getCharset() : null;
74 if (charset == null) {
75 charset = StandardCharsets.US_ASCII;
76 }
77 setCharset(charset);
78 start(promise, response, contentType != null ? contentType : ContentType.DEFAULT_TEXT);
79 } else {
80 start(promise, response, null);
81 completed();
82 }
83 }
84
85 @Override
86 public void failed(final Exception cause) {
87 }
88
89 }