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.io;
29  
30  import org.apache.hc.core5.annotation.Contract;
31  import org.apache.hc.core5.annotation.ThreadingBehavior;
32  import org.apache.hc.core5.http.ClassicHttpResponse;
33  import org.apache.hc.core5.http.HttpResponseFactory;
34  import org.apache.hc.core5.http.ReasonPhraseCatalog;
35  import org.apache.hc.core5.http.impl.EnglishReasonPhraseCatalog;
36  import org.apache.hc.core5.http.message.BasicClassicHttpResponse;
37  import org.apache.hc.core5.util.Args;
38  
39  /**
40   * Default factory for creating {@link ClassicHttpResponse} objects.
41   *
42   * @since 4.0
43   */
44  @Contract(threading = ThreadingBehavior.IMMUTABLE_CONDITIONAL)
45  public class DefaultClassicHttpResponseFactory implements HttpResponseFactory<ClassicHttpResponse> {
46  
47      public static final DefaultClassicHttpResponseFactoryttpResponseFactory.html#DefaultClassicHttpResponseFactory">DefaultClassicHttpResponseFactory INSTANCE = new DefaultClassicHttpResponseFactory();
48  
49      private final ReasonPhraseCatalog reasonCatalog;
50  
51      /**
52       * Creates a new response factory with the given catalog.
53       *
54       * @param catalog   the catalog of reason phrases
55       */
56      public DefaultClassicHttpResponseFactory(final ReasonPhraseCatalog catalog) {
57          this.reasonCatalog = Args.notNull(catalog, "Reason phrase catalog");
58      }
59  
60      /**
61       * Creates a new response factory with the default catalog.
62       * The default catalog is {@link EnglishReasonPhraseCatalog}.
63       */
64      public DefaultClassicHttpResponseFactory() {
65          this(EnglishReasonPhraseCatalog.INSTANCE);
66      }
67  
68      @Override
69      public ClassicHttpResponse newHttpResponse(final int status, final String reasonPhrase) {
70          return new BasicClassicHttpResponse(status, reasonPhrase);
71      }
72  
73      @Override
74      public ClassicHttpResponse newHttpResponse(final int status) {
75          return new BasicClassicHttpResponse(status, this.reasonCatalog, null);
76      }
77  
78  }