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; 29 30 import java.util.Locale; 31 32 /** 33 * After receiving and interpreting a request message, a server responds 34 * with an HTTP response message. 35 * 36 * @since 4.0 37 */ 38 public interface HttpResponse extends HttpMessage { 39 40 /** 41 * Obtains the code of this response message. 42 * 43 * @return the status code. 44 */ 45 int getCode(); 46 47 /** 48 * Updates status code of this response message. 49 * 50 * @param code the HTTP status code. 51 * 52 * @see HttpStatus 53 */ 54 void setCode(int code); 55 56 /** 57 * Obtains the reason phrase of this response if available. 58 * 59 * @return the reason phrase. 60 */ 61 String getReasonPhrase(); 62 63 /** 64 * Updates the status line of this response with a new reason phrase. 65 * 66 * @param reason the new reason phrase as a single-line string, or 67 * {@code null} to unset the reason phrase 68 */ 69 void setReasonPhrase(String reason); 70 71 /** 72 * Obtains the locale of this response. 73 * The locale is used to determine the reason phrase 74 * for the {@link #setCode status code}. 75 * It can be changed using {@link #setLocale setLocale}. 76 * 77 * @return the locale of this response, never {@code null} 78 */ 79 Locale getLocale(); 80 81 /** 82 * Changes the locale of this response. 83 * 84 * @param loc the new locale 85 */ 86 void setLocale(Locale loc); 87 88 }