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