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/HttpMessage.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 610823 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-01-10 07:53:53 -0800 (Thu, 10 Jan 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 Projectimport org.apache.http.params.HttpParams; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * A generic HTTP message. 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Holds what is common between requests and responses. 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 610823 $ 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic interface HttpMessage { 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the protocol version this message is compatible with. 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ProtocolVersion getProtocolVersion(); 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Checks if a certain header is present in this message. Header values are 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ignored. 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param name the header name to check for. 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return true if at least one header with this name is present. 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean containsHeader(String name); 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns all the headers with a specified name of this message. Header values 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * are ignored. Headers are orderd in the sequence they will be sent over a 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * connection. 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param name the name of the headers to return. 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the headers whose name property equals <code>name</code>. 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Header[] getHeaders(String name); 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the first header with a specified name of this message. Header 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * values are ignored. If there is more than one matching header in the 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * message the first element of {@link #getHeaders(String)} is returned. 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If there is no matching header in the message <code>null</code> is 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * returned. 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param name the name of the header to return. 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the first header whose name property equals <code>name</code> 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or <code>null</code> if no such header could be found. 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Header getFirstHeader(String name); 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the last header with a specified name of this message. Header values 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * are ignored. If there is more than one matching header in the message the 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * last element of {@link #getHeaders(String)} is returned. If there is no 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * matching header in the message <code>null</code> is returned. 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param name the name of the header to return. 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the last header whose name property equals <code>name</code>. 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or <code>null</code> if no such header could be found. 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Header getLastHeader(String name); 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns all the headers of this message. Headers are orderd in the sequence 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * they will be sent over a connection. 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return all the headers of this message 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Header[] getAllHeaders(); 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Adds a header to this message. The header will be appended to the end of 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the list. 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param header the header to append. 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void addHeader(Header header); 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Adds a header to this message. The header will be appended to the end of 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the list. 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param name the name of the header. 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param value the value of the header. 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void addHeader(String name, String value); 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Overwrites the first header with the same name. The new header will be appended to 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the end of the list, if no header with the given name can be found. 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param header the header to set. 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setHeader(Header header); 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Overwrites the first header with the same name. The new header will be appended to 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the end of the list, if no header with the given name can be found. 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param name the name of the header. 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param value the value of the header. 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setHeader(String name, String value); 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Overwrites all the headers in the message. 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param headers the array of headers to set. 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setHeaders(Header[] headers); 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Removes a header from this message. 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param header the header to remove. 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void removeHeader(Header header); 152069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 153069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 154069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Removes all headers with a certain name from this message. 155069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 156069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param name The name of the headers to remove. 157069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 158069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void removeHeaders(String name); 159069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 160069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 161069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns an iterator of all the headers. 162069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 163069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return Iterator that returns Header objects in the sequence they are 164069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * sent over a connection. 165069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 166069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project HeaderIterator headerIterator(); 167069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 168069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 169069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns an iterator of the headers with a given name. 170069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 171069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param name the name of the headers over which to iterate, or 172069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>null</code> for all headers 173069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 174069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return Iterator that returns Header objects with the argument name 175069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * in the sequence they are sent over a connection. 176069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 177069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project HeaderIterator headerIterator(String name); 178069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 179069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 180069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the parameters effective for this message as set by 181069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * {@link #setParams(HttpParams)}. 182069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 183069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project HttpParams getParams(); 184069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 185069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 186069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Provides parameters to be used for the processing of this message. 187069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param params the parameters 188069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 189069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setParams(HttpParams params); 190069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 191069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 192