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 * @throws HttpException If a protocol error occurs.
56 * @throws IOException If an I/O error occurs.
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 start(promise, response, contentType != null ? contentType : ContentType.DEFAULT_BINARY);
74 } else {
75 start(promise, response, null);
76 completed();
77 }
78 }
79
80 @Override
81 public void failed(final Exception cause) {
82 }
83
84 }