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  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.config.CharCodingConfig;
41  import org.apache.hc.core5.http.nio.AsyncPushConsumer;
42  import org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer;
43  import org.apache.hc.core5.http.protocol.HttpContext;
44  
45  /**
46   * Abstract push response consumer that processes response body data as a character stream.
47   *
48   * @since 5.0
49   */
50  public abstract class AbstractCharPushConsumer extends AbstractCharDataConsumer implements AsyncPushConsumer {
51  
52      private final Charset defaultCharset;
53  
54      public AbstractCharPushConsumer() {
55          this.defaultCharset = StandardCharsets.UTF_8;
56      }
57  
58      protected AbstractCharPushConsumer(final int bufSize,
59                                         final CharCodingConfig charCodingConfig) {
60          super(bufSize, charCodingConfig);
61          this.defaultCharset = charCodingConfig != null && charCodingConfig.getCharset() != null
62                  ? charCodingConfig.getCharset() : StandardCharsets.UTF_8;
63      }
64  
65      /**
66       * Triggered to signal the beginning of data processing.
67       *
68       * @param response the response message head
69       * @param contentType the content type of the response body,
70       *                    or {@code null} if the response does not enclose a response entity.
71       */
72      protected abstract void start(HttpRequest promise, HttpResponse response, ContentType contentType) throws HttpException, IOException;
73  
74      @Override
75      public final void consumePromise(
76              final HttpRequest promise,
77              final HttpResponse response,
78              final EntityDetails entityDetails,
79              final HttpContext context) throws HttpException, IOException {
80          if (entityDetails != null) {
81              final ContentType contentType;
82              try {
83                  contentType = ContentType.parse(entityDetails.getContentType());
84              } catch (final UnsupportedCharsetException ex) {
85                  throw new UnsupportedEncodingException(ex.getMessage());
86              }
87              Charset charset = contentType != null ? contentType.getCharset() : null;
88              if (charset == null) {
89                  charset = defaultCharset;
90              }
91              setCharset(charset);
92              start(promise, response, contentType != null ? contentType : ContentType.DEFAULT_TEXT);
93          } else {
94              start(promise, response, null);
95              completed();
96          }
97      }
98  
99      @Override
100     public void failed(final Exception cause) {
101     }
102 
103 }