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.concurrent.FutureCallback;
34 import org.apache.hc.core5.http.ContentType;
35 import org.apache.hc.core5.http.EntityDetails;
36 import org.apache.hc.core5.http.HttpException;
37 import org.apache.hc.core5.http.HttpResponse;
38 import org.apache.hc.core5.http.nio.AsyncResponseConsumer;
39 import org.apache.hc.core5.http.nio.entity.AbstractBinDataConsumer;
40 import org.apache.hc.core5.http.protocol.HttpContext;
41
42 /**
43 * Abstract response consumer that processes response body data as an octet stream.
44 *
45 * @since 5.0
46 *
47 * @param <T> response message representation.
48 */
49 public abstract class AbstractBinResponseConsumer<T> extends AbstractBinDataConsumer implements AsyncResponseConsumer<T> {
50
51 private volatile FutureCallback<T> resultCallback;
52
53 /**
54 * Triggered to signal the beginning of response processing.
55 *
56 * @param response the response message head
57 * @param contentType the content type of the response body,
58 * or {@code null} if the response does not enclose a response entity.
59 */
60 protected abstract void start(HttpResponse response, ContentType contentType) throws HttpException, IOException;
61
62 /**
63 * Triggered to generate object that represents a result of response message processing.
64 *
65 * @return the result of response processing.
66 */
67 protected abstract T buildResult();
68
69 @Override
70 public void informationResponse(
71 final HttpResponse response,
72 final HttpContext context) throws HttpException, IOException {
73 }
74
75 @Override
76 public final void consumeResponse(
77 final HttpResponse response,
78 final EntityDetails entityDetails,
79 final HttpContext context,
80 final FutureCallback<T> resultCallback) throws HttpException, IOException {
81 this.resultCallback = resultCallback;
82 if (entityDetails != null) {
83 try {
84 final ContentType contentType = ContentType.parse(entityDetails.getContentType());
85 start(response, contentType != null ? contentType : ContentType.DEFAULT_BINARY);
86 } catch (final UnsupportedCharsetException ex) {
87 throw new UnsupportedEncodingException(ex.getMessage());
88 }
89 } else {
90 start(response, null);
91 completed();
92 }
93
94 }
95
96 @Override
97 protected final void completed() {
98 resultCallback.completed(buildResult());
99 }
100
101 @Override
102 public void failed(final Exception cause) {
103 }
104
105 }