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.http;
29  
30  import org.apache.http.protocol.HttpContext;
31  
32  /**
33   * A factory for {@link HttpResponse HttpResponse} objects.
34   *
35   * @since 4.0
36   */
37  public interface HttpResponseFactory {
38  
39      /**
40       * Creates a new response from status line elements.
41       *
42       * @param ver       the protocol version
43       * @param status    the status code
44       * @param context   the context from which to determine the locale
45       *                  for looking up a reason phrase to the status code, or
46       *                  <code>null</code> to use the default locale
47       *
48       * @return  the new response with an initialized status line
49       */
50      HttpResponse newHttpResponse(ProtocolVersion ver, int status,
51                                   HttpContext context);
52  
53      /**
54       * Creates a new response from a status line.
55       *
56       * @param statusline the status line
57       * @param context    the context from which to determine the locale
58       *                   for looking up a reason phrase if the status code
59       *                   is updated, or
60       *                   <code>null</code> to use the default locale
61       *
62       * @return  the new response with the argument status line
63       */
64      HttpResponse newHttpResponse(StatusLine statusline,
65                                   HttpContext context);
66  
67  }