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 31 import org.apache.hc.core5.http.ContentType; 32 import org.apache.hc.core5.http.HttpException; 33 import org.apache.hc.core5.http.HttpResponse; 34 import org.apache.hc.core5.http.nio.AsyncEntityConsumer; 35 import org.apache.hc.core5.http.nio.support.AbstractAsyncResponseConsumer; 36 import org.apache.hc.core5.http.protocol.HttpContext; 37 38 /** 39 * HTTP response consumer that generates a {@link SimpleHttpResponse} instance based on events 40 * of an incoming data stream. 41 * <p> 42 * IMPORTANT: {@link SimpleHttpResponse}s are intended for simple scenarios where entities inclosed 43 * in responses are known to be small. It is generally recommended to use streaming 44 * {@link org.apache.hc.core5.http.nio.AsyncResponseConsumer}s, for instance, such as based on 45 * {@link AbstractCharResponseConsumer} or {@link AbstractBinResponseConsumer}. 46 * 47 * @since 5.0 48 * 49 * @see SimpleBody 50 * @see SimpleHttpResponse 51 * @see AbstractCharResponseConsumer 52 * @see AbstractBinResponseConsumer 53 */ 54 public final class SimpleResponseConsumer extends AbstractAsyncResponseConsumer<SimpleHttpResponse, byte[]> { 55 56 SimpleResponseConsumer(final AsyncEntityConsumer<byte[]> entityConsumer) { 57 super(entityConsumer); 58 } 59 60 public static SimpleResponseConsumer create() { 61 return new SimpleResponseConsumer(new SimpleAsyncEntityConsumer()); 62 } 63 64 @Override 65 public void informationResponse(final HttpResponse response, final HttpContext context) throws HttpException, IOException { 66 } 67 68 @Override 69 protected SimpleHttpResponse buildResult(final HttpResponse response, final byte[] entity, final ContentType contentType) { 70 final SimpleHttpResponse simpleResponse = SimpleHttpResponse.copy(response); 71 if (entity != null) { 72 simpleResponse.setBody(entity, contentType); 73 } 74 return simpleResponse; 75 } 76 77 }