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.core5.http.nio;
28
29 import java.io.IOException;
30
31 import org.apache.hc.core5.concurrent.FutureCallback;
32 import org.apache.hc.core5.http.EntityDetails;
33 import org.apache.hc.core5.http.HttpException;
34
35 /**
36 * Abstract asynchronous message entity consumer.
37 *
38 * @param <T> entity representation.
39 *
40 * @since 5.0
41 */
42 public interface AsyncEntityConsumer<T> extends AsyncDataConsumer {
43
44 /**
45 * Signals beginning of an incoming request entity stream.
46 *
47 * @param entityDetails the details of the incoming message entity.
48 * @param resultCallback the result callback.
49 */
50 void streamStart(EntityDetails entityDetails, FutureCallback<T> resultCallback) throws HttpException, IOException;
51
52 /**
53 * Triggered to signal a failure in data processing.
54 *
55 * @param cause the cause of the failure.
56 */
57 void failed(Exception cause);
58
59 /**
60 * Returns the result of entity processing when it becomes available or {@code null}
61 * if the entity is still being received.
62 *
63 * @return the response processing result.
64 */
65 T getContent();
66
67 }