001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http;
029
030import org.apache.http.protocol.HttpContext;
031
032/**
033 * A factory for {@link HttpResponse HttpResponse} objects.
034 *
035 * @since 4.0
036 */
037public interface HttpResponseFactory {
038
039    /**
040     * Creates a new response from status line elements.
041     *
042     * @param ver       the protocol version
043     * @param status    the status code
044     * @param context   the context from which to determine the locale
045     *                  for looking up a reason phrase to the status code, or
046     *                  {@code null} to use the default locale
047     *
048     * @return  the new response with an initialized status line
049     */
050    HttpResponse newHttpResponse(ProtocolVersion ver, int status,
051                                 HttpContext context);
052
053    /**
054     * Creates a new response from a status line.
055     *
056     * @param statusline the status line
057     * @param context    the context from which to determine the locale
058     *                   for looking up a reason phrase if the status code
059     *                   is updated, or
060     *                   {@code null} to use the default locale
061     *
062     * @return  the new response with the argument status line
063     */
064    HttpResponse newHttpResponse(StatusLine statusline,
065                                 HttpContext context);
066
067}