1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpResponse.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 652956 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-05-02 17:13:05 -0700 (Fri, 02 May 2008) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or more contributor license agreements. See the NOTICE file 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed with this work for additional information 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * regarding copyright ownership. The ASF licenses this file 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to you under the Apache License, Version 2.0 (the 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "License"); you may not use this file except in compliance 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with the License. You may obtain a copy of the License at 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * software distributed under the License is distributed on an 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * KIND, either express or implied. See the License for the 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specific language governing permissions and limitations 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * under the License. 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.Locale; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * An HTTP response. 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 652956 $ 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic interface HttpResponse extends HttpMessage { 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Obtains the status line of this response. 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The status line can be set using one of the 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * {@link #setStatusLine setStatusLine} methods, 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or it can be initialized in a constructor. 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the status line, or <code>null</code> if not yet set 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project StatusLine getStatusLine(); 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Sets the status line of this response. 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param statusline the status line of this response 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setStatusLine(StatusLine statusline); 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Sets the status line of this response. 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The reason phrase will be determined based on the current 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * {@link #getLocale locale}. 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param ver the HTTP version 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param code the status code 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setStatusLine(ProtocolVersion ver, int code); 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Sets the status line of this response with a reason phrase. 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param ver the HTTP version 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param code the status code 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param reason the reason phrase, or <code>null</code> to omit 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setStatusLine(ProtocolVersion ver, int code, String reason); 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Updates the status line of this response with a new status code. 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The status line can only be updated if it is available. It must 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * have been set either explicitly or in a constructor. 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <br/> 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The reason phrase will be updated according to the new status code, 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * based on the current {@link #getLocale locale}. It can be set 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * explicitly using {@link #setReasonPhrase setReasonPhrase}. 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param code the HTTP status code. 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws IllegalStateException 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * if the status line has not be set 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see HttpStatus 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #setStatusLine(StatusLine) 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #setStatusLine(ProtocolVersion,int) 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setStatusCode(int code) 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IllegalStateException; 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Updates the status line of this response with a new reason phrase. 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The status line can only be updated if it is available. It must 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * have been set either explicitly or in a constructor. 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param reason the new reason phrase as a single-line string, or 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>null</code> to unset the reason phrase 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws IllegalStateException 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * if the status line has not be set 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #setStatusLine(StatusLine) 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #setStatusLine(ProtocolVersion,int) 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setReasonPhrase(String reason) 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IllegalStateException; 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Obtains the message entity of this response, if any. 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The entity is provided by calling {@link #setEntity setEntity}. 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the response entity, or 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>null</code> if there is none 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project HttpEntity getEntity(); 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Associates a response entity with this response. 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param entity the entity to associate with this response, or 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>null</code> to unset 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setEntity(HttpEntity entity); 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Obtains the locale of this response. 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The locale is used to determine the reason phrase 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * for the {@link #setStatusCode status code}. 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * It can be changed using {@link #setLocale setLocale}. 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the locale of this response, never <code>null</code> 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Locale getLocale(); 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Changes the locale of this response. 152069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If there is a status line, it's reason phrase will be updated 153069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * according to the status code and new locale. 154069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 155069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param loc the new locale 156069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 157069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #getLocale getLocale 158069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #setStatusCode setStatusCode 159069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 160069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setLocale(Locale loc); 161069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 162