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