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.CharBuffer;
31  
32  import org.apache.hc.core5.http.ContentType;
33  import org.apache.hc.core5.http.HttpException;
34  import org.apache.hc.core5.http.config.CharCodingConfig;
35  import org.apache.hc.core5.util.Args;
36  import org.apache.hc.core5.util.CharArrayBuffer;
37  
38  /**
39   * Basic {@link org.apache.hc.core5.http.nio.AsyncEntityConsumer} implementation
40   * that processes the data stream content into a string.
41   *
42   * @since 5.0
43   */
44  public class StringAsyncEntityConsumer extends AbstractCharAsyncEntityConsumer<String> {
45  
46      private final int capacityIncrement;
47      private final CharArrayBuffer content;
48  
49      public StringAsyncEntityConsumer(final int bufSize, final int capacityIncrement, final CharCodingConfig charCodingConfig) {
50          super(bufSize, charCodingConfig);
51          this.capacityIncrement = Args.positive(capacityIncrement, "Capacity increment");
52          this.content = new CharArrayBuffer(1024);
53      }
54  
55      public StringAsyncEntityConsumer(final int capacityIncrement) {
56          this(DEF_BUF_SIZE, capacityIncrement, CharCodingConfig.DEFAULT);
57      }
58  
59      public StringAsyncEntityConsumer(final CharCodingConfig charCodingConfig) {
60          this(DEF_BUF_SIZE, Integer.MAX_VALUE, charCodingConfig);
61      }
62  
63      public StringAsyncEntityConsumer() {
64          this(Integer.MAX_VALUE);
65      }
66  
67      @Override
68      protected final void streamStart(final ContentType contentType) throws HttpException, IOException {
69      }
70  
71      @Override
72      protected int capacityIncrement() {
73          return capacityIncrement;
74      }
75  
76      @Override
77      protected final void data(final CharBuffer src, final boolean endOfStream) {
78          Args.notNull(src, "CharBuffer");
79          final int chunk = src.remaining();
80          content.ensureCapacity(chunk);
81          src.get(content.array(), content.length(), chunk);
82          content.setLength(content.length() + chunk);
83      }
84  
85      @Override
86      public String generateContent() {
87          return content.toString();
88      }
89  
90      @Override
91      public void releaseResources() {
92          content.clear();
93      }
94  
95  }