1/*
2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpResponseFactory.java $
3 * $Revision: 573864 $
4 * $Date: 2007-09-08 08:53:25 -0700 (Sat, 08 Sep 2007) $
5 *
6 * ====================================================================
7 * Licensed to the Apache Software Foundation (ASF) under one
8 * or more contributor license agreements.  See the NOTICE file
9 * distributed with this work for additional information
10 * regarding copyright ownership.  The ASF licenses this file
11 * to you under the Apache License, Version 2.0 (the
12 * "License"); you may not use this file except in compliance
13 * with the License.  You may obtain a copy of the License at
14 *
15 *   http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing,
18 * software distributed under the License is distributed on an
19 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20 * KIND, either express or implied.  See the License for the
21 * specific language governing permissions and limitations
22 * under the License.
23 * ====================================================================
24 *
25 * This software consists of voluntary contributions made by many
26 * individuals on behalf of the Apache Software Foundation.  For more
27 * information on the Apache Software Foundation, please see
28 * <http://www.apache.org/>.
29 *
30 */
31
32package org.apache.http;
33
34import org.apache.http.protocol.HttpContext;
35
36
37/**
38 * A factory for {@link HttpResponse HttpResponse} objects.
39 *
40 * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
41 *
42 * @version $Revision: 573864 $
43 *
44 * @since 4.0
45 */
46public interface HttpResponseFactory {
47
48    /**
49     * Creates a new response from status line elements.
50     *
51     * @param ver       the protocol version
52     * @param status    the status code
53     * @param context   the context from which to determine the locale
54     *                  for looking up a reason phrase to the status code, or
55     *                  <code>null</code> to use the default locale
56     *
57     * @return  the new response with an initialized status line
58     */
59    HttpResponse newHttpResponse(ProtocolVersion ver, int status,
60                                 HttpContext context);
61
62    /**
63     * Creates a new response from a status line.
64     *
65     * @param statusline the status line
66     * @param context    the context from which to determine the locale
67     *                   for looking up a reason phrase if the status code
68     *                   is updated, or
69     *                   <code>null</code> to use the default locale
70     *
71     * @return  the new response with the argument status line
72     */
73    HttpResponse newHttpResponse(StatusLine statusline,
74                                 HttpContext context);
75
76}
77