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