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 java.util.Locale;
031
032/**
033 * Interface for obtaining reason phrases for HTTP status codes.
034 *
035 * @since 4.0
036 */
037public interface ReasonPhraseCatalog {
038
039    /**
040     * Obtains the reason phrase for a status code.
041     * The optional context allows for catalogs that detect
042     * the language for the reason phrase.
043     *
044     * @param status    the status code, in the range 100-599
045     * @param loc       the preferred locale for the reason phrase
046     *
047     * @return  the reason phrase, or {@code null} if unknown
048     */
049    String getReason(int status, Locale loc);
050
051}