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  
28  package org.apache.hc.core5.http.impl.nio;
29  
30  import java.io.IOException;
31  
32  import org.apache.hc.core5.http.HttpResponse;
33  import org.apache.hc.core5.http.HttpVersion;
34  import org.apache.hc.core5.http.config.Http1Config;
35  import org.apache.hc.core5.http.message.LineFormatter;
36  import org.apache.hc.core5.http.message.StatusLine;
37  import org.apache.hc.core5.util.CharArrayBuffer;
38  
39  /**
40   * Default {@link org.apache.hc.core5.http.nio.NHttpMessageWriter} implementation for {@link HttpResponse}s.
41   *
42   * @since 4.1
43   */
44  public class DefaultHttpResponseWriter<T extends HttpResponse> extends AbstractMessageWriter<T> {
45  
46      private final Http1Config http1Config;
47  
48      /**
49       * @since 5.3
50       */
51      public DefaultHttpResponseWriter(final LineFormatter formatter, final Http1Config http1Config) {
52          super(formatter);
53          this.http1Config = http1Config != null ? http1Config : Http1Config.DEFAULT;
54      }
55  
56      /**
57       * Creates an instance of DefaultHttpResponseWriter.
58       *
59       * @param formatter the line formatter If {@code null}
60       *   {@link org.apache.hc.core5.http.message.BasicLineFormatter#INSTANCE} will be used.
61       *
62       * @since 4.3
63       */
64      public DefaultHttpResponseWriter(final LineFormatter formatter) {
65          this(formatter, null);
66      }
67  
68      /**
69       * @since 4.3
70       */
71      public DefaultHttpResponseWriter() {
72          this(null, null);
73      }
74  
75      /**
76       * Determines the HTTP protocol version to be communicated to the opposite
77       * endpoint in the message header.
78       *
79       * @since 5.3
80       */
81      protected HttpVersion protocolVersion(final T request) {
82          return http1Config.getVersion();
83      }
84  
85      @Override
86      protected void writeHeadLine(final T message, final CharArrayBuffer lineBuf) throws IOException {
87          lineBuf.clear();
88          getLineFormatter().formatStatusLine(lineBuf, new StatusLine(
89                  protocolVersion(message),
90                  message.getCode(),
91                  message.getReasonPhrase()));
92      }
93  
94  }