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.core5.http.nio.entity;
28  
29  import java.io.IOException;
30  import java.nio.ByteBuffer;
31  import java.util.List;
32  
33  import org.apache.hc.core5.concurrent.FutureCallback;
34  import org.apache.hc.core5.http.EntityDetails;
35  import org.apache.hc.core5.http.Header;
36  import org.apache.hc.core5.http.HttpException;
37  import org.apache.hc.core5.http.nio.AsyncEntityConsumer;
38  import org.apache.hc.core5.http.nio.CapacityChannel;
39  
40  /**
41   * No-op {@link AsyncEntityConsumer} that discards all data from the data stream.
42   *
43   * @since 5.0
44   */
45  public final class NoopEntityConsumer implements AsyncEntityConsumer<Void> {
46  
47      private volatile FutureCallback<Void> resultCallback;
48  
49      @Override
50      public final void streamStart(
51              final EntityDetails entityDetails,
52              final FutureCallback<Void> resultCallback) throws IOException, HttpException {
53          this.resultCallback = resultCallback;
54      }
55  
56      @Override
57      public void updateCapacity(final CapacityChannel capacityChannel) throws IOException {
58          capacityChannel.update(Integer.MAX_VALUE);
59      }
60  
61      @Override
62      public final void consume(final ByteBuffer src) throws IOException {
63      }
64  
65      @Override
66      public final void streamEnd(final List<? extends Header> trailers) throws IOException {
67          if (resultCallback != null) {
68              resultCallback.completed(null);
69          }
70      }
71  
72      @Override
73      public void failed(final Exception cause) {
74          if (resultCallback != null) {
75              resultCallback.failed(cause);
76          }
77      }
78  
79      @Override
80      public Void getContent() {
81          return null;
82      }
83  
84      @Override
85      public void releaseResources() {
86      }
87  
88  }