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.support;
28  
29  import java.io.IOException;
30  
31  import org.apache.hc.core5.http.HttpException;
32  import org.apache.hc.core5.http.HttpResponse;
33  import org.apache.hc.core5.http.HttpStatus;
34  import org.apache.hc.core5.http.message.BasicHttpResponse;
35  import org.apache.hc.core5.http.nio.AsyncEntityProducer;
36  import org.apache.hc.core5.http.nio.AsyncPushProducer;
37  import org.apache.hc.core5.http.nio.DataStreamChannel;
38  import org.apache.hc.core5.http.nio.ResponseChannel;
39  import org.apache.hc.core5.http.protocol.HttpContext;
40  import org.apache.hc.core5.util.Args;
41  
42  /**
43   * Basic implementation of {@link AsyncPushProducer} that produces one fixed response
44   * and relies on a {@link AsyncEntityProducer} to generate response entity stream.
45   *
46   * @since 5.0
47   */
48  public class BasicPushProducer implements AsyncPushProducer {
49  
50      private final HttpResponse response;
51      private final AsyncEntityProducer dataProducer;
52  
53      public BasicPushProducer(final HttpResponse response, final AsyncEntityProducer dataProducer) {
54          this.response = Args.notNull(response, "Response");
55          this.dataProducer = Args.notNull(dataProducer, "Entity producer");
56      }
57  
58      public BasicPushProducer(final int code, final AsyncEntityProducer dataProducer) {
59          this(new BasicHttpResponse(code), dataProducer);
60      }
61  
62      public BasicPushProducer(final AsyncEntityProducer dataProducer) {
63          this(HttpStatus.SC_OK, dataProducer);
64      }
65  
66      @Override
67      public void produceResponse(final ResponseChannel channel, final HttpContext httpContext) throws HttpException, IOException {
68          channel.sendResponse(response, dataProducer, httpContext);
69      }
70  
71      @Override
72      public int available() {
73          return dataProducer != null ? dataProducer.available() : 0;
74      }
75  
76      @Override
77      public void produce(final DataStreamChannel channel) throws IOException {
78          if (dataProducer != null) {
79              dataProducer.produce(channel);
80          }
81      }
82  
83      @Override
84      public void failed(final Exception cause) {
85          releaseResources();
86      }
87  
88      @Override
89      public void releaseResources() {
90          if (dataProducer != null) {
91              dataProducer.releaseResources();
92          }
93      }
94  
95  }