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.nio.CharBuffer;
32  import java.nio.charset.Charset;
33  import java.nio.charset.CharsetDecoder;
34  import java.nio.charset.CoderResult;
35  import java.nio.charset.StandardCharsets;
36  import java.util.List;
37  
38  import org.apache.hc.core5.http.Header;
39  import org.apache.hc.core5.http.HttpException;
40  import org.apache.hc.core5.http.config.CharCodingConfig;
41  import org.apache.hc.core5.http.nio.AsyncDataConsumer;
42  import org.apache.hc.core5.http.nio.CapacityChannel;
43  import org.apache.hc.core5.util.Args;
44  
45  /**
46   * Abstract text data consumer.
47   *
48   * @since 5.0
49   */
50  public abstract class AbstractCharDataConsumer implements AsyncDataConsumer {
51  
52      protected static final int DEF_BUF_SIZE = 8192;
53      private static final ByteBuffer EMPTY_BIN = ByteBuffer.wrap(new byte[0]);
54  
55      private final CharBuffer charbuf;
56      private final CharCodingConfig charCodingConfig;
57  
58      private volatile Charset charset;
59      private volatile CharsetDecoder charsetDecoder;
60  
61      protected AbstractCharDataConsumer(final int bufSize, final CharCodingConfig charCodingConfig) {
62          this.charbuf = CharBuffer.allocate(Args.positive(bufSize, "Buffer size"));
63          this.charCodingConfig = charCodingConfig != null ? charCodingConfig : CharCodingConfig.DEFAULT;
64      }
65  
66      public AbstractCharDataConsumer() {
67          this(DEF_BUF_SIZE, CharCodingConfig.DEFAULT);
68      }
69      /**
70       * Triggered to obtain the capacity increment.
71       *
72       * @return the number of bytes this consumer is prepared to process.
73       */
74      protected abstract int capacityIncrement();
75  
76      /**
77       * Triggered to pass incoming data packet to the data consumer.
78       *
79       * @param src the data packet.
80       * @param endOfStream flag indicating whether this data packet is the last in the data stream.
81       *
82       */
83      protected abstract void data(CharBuffer src, boolean endOfStream) throws IOException;
84  
85      /**
86       * Triggered to signal completion of data processing.
87       */
88      protected abstract void completed() throws IOException;
89  
90      protected final void setCharset(final Charset charset) {
91          this.charset = charset != null ? charset : charCodingConfig.getCharset();
92          this.charsetDecoder = null;
93      }
94  
95      @Override
96      public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException {
97          capacityChannel.update(capacityIncrement());
98      }
99  
100     private void checkResult(final CoderResult result) throws IOException {
101         if (result.isError()) {
102             result.throwException();
103         }
104     }
105 
106     private void doDecode(final boolean endOfStream) throws IOException {
107         charbuf.flip();
108         data(charbuf, endOfStream);
109         charbuf.clear();
110     }
111 
112     private CharsetDecoder getCharsetDecoder() {
113         if (charsetDecoder == null) {
114             Charset charset = this.charset;
115             if (charset == null) {
116                 charset = charCodingConfig.getCharset();
117             }
118             if (charset == null) {
119                 charset = StandardCharsets.US_ASCII;
120             }
121             charsetDecoder = charset.newDecoder();
122             if (charCodingConfig.getMalformedInputAction() != null) {
123                 charsetDecoder.onMalformedInput(charCodingConfig.getMalformedInputAction());
124             }
125             if (charCodingConfig.getUnmappableInputAction() != null) {
126                 charsetDecoder.onUnmappableCharacter(charCodingConfig.getUnmappableInputAction());
127             }
128         }
129         return charsetDecoder;
130     }
131 
132     @Override
133     public final void consume(final ByteBuffer src) throws IOException {
134         final CharsetDecoder charsetDecoder = getCharsetDecoder();
135         while (src.hasRemaining()) {
136             checkResult(charsetDecoder.decode(src, charbuf, false));
137             doDecode(false);
138         }
139     }
140 
141     @Override
142     public final void streamEnd(final List<? extends Header> trailers) throws HttpException, IOException {
143         final CharsetDecoder charsetDecoder = getCharsetDecoder();
144         checkResult(charsetDecoder.decode(EMPTY_BIN, charbuf, true));
145         doDecode(false);
146         checkResult(charsetDecoder.flush(charbuf));
147         doDecode(true);
148         completed();
149     }
150 
151 }