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.http.Header;
34  import org.apache.hc.core5.http.HttpException;
35  import org.apache.hc.core5.http.nio.AsyncDataConsumer;
36  import org.apache.hc.core5.http.nio.CapacityChannel;
37  
38  public abstract class AbstractBinDataConsumer implements AsyncDataConsumer {
39  
40      private static final ByteBuffer EMPTY = ByteBuffer.wrap(new byte[0]);
41  
42      protected abstract int capacity();
43  
44      protected abstract void data(ByteBuffer data, boolean endOfStream) throws IOException;
45  
46      protected abstract void completed() throws IOException;
47  
48      @Override
49      public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException {
50          capacityChannel.update(capacity());
51      }
52  
53      @Override
54      public final int consume(final ByteBuffer src) throws IOException {
55          data(src, false);
56          return capacity();
57      }
58  
59      @Override
60      public final void streamEnd(final List<? extends Header> trailers) throws HttpException, IOException {
61          data(EMPTY, true);
62          completed();
63      }
64  
65  }