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/params/BasicHttpParams.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 610464 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-01-09 09:10:55 -0800 (Wed, 09 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.params; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.Serializable; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.Map; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.HashMap; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.Iterator; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.params.HttpParams; 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This class represents a collection of HTTP protocol parameters. 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Protocol parameters may be linked together to form a hierarchy. 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If a particular parameter value has not been explicitly defined 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * in the collection itself, its value will be drawn from the parent 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * collection of parameters. 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 610464 $ 51d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * 52d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * @deprecated Please use {@link java.net.URL#openConnection} instead. 53d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 54d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * for further details. 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 56d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath@Deprecated 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic final class BasicHttpParams extends AbstractHttpParams 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project implements Serializable, Cloneable { 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private static final long serialVersionUID = -7086398485908701455L; 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** Map of HTTP parameters that this collection contains. */ 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private HashMap parameters; 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public BasicHttpParams() { 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(); 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public Object getParameter(final String name) { 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // See if the parameter has been explicitly defined 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Object param = null; 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.parameters != null) { 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project param = this.parameters.get(name); 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return param; 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public HttpParams setParameter(final String name, final Object value) { 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.parameters == null) { 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.parameters = new HashMap(); 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.parameters.put(name, value); 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return this; 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean removeParameter(String name) { 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.parameters == null) { 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return false; 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project //this is to avoid the case in which the key has a null value 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.parameters.containsKey(name)) { 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.parameters.remove(name); 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return true; 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } else { 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return false; 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Assigns the value to all the parameter with the given names 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param names array of parameter name 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param value parameter value 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void setParameters(final String[] names, final Object value) { 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project for (int i = 0; i < names.length; i++) { 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project setParameter(names[i], value); 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean isParameterSet(final String name) { 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return getParameter(name) != null; 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean isParameterSetLocally(final String name) { 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return this.parameters != null && this.parameters.get(name) != null; 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Removes all parameters from this collection. 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void clear() { 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.parameters = null; 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Creates a copy of these parameters. 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The implementation here instantiates {@link BasicHttpParams}, 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * then calls {@link #copyParams(HttpParams)} to populate the copy. 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return a new set of params holding a copy of the 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <i>local</i> parameters in this object. 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public HttpParams copy() { 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project BasicHttpParams clone = new BasicHttpParams(); 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project copyParams(clone); 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return clone; 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public Object clone() throws CloneNotSupportedException { 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project BasicHttpParams clone = (BasicHttpParams) super.clone(); 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project copyParams(clone); 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return clone; 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Copies the locally defined parameters to the argument parameters. 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This method is called from {@link #copy()}. 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param target the parameters to which to copy 152069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 153069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected void copyParams(HttpParams target) { 154069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.parameters == null) 155069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return; 156069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 157069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Iterator iter = parameters.entrySet().iterator(); 158069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project while (iter.hasNext()) { 159069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Map.Entry me = (Map.Entry) iter.next(); 160069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (me.getKey() instanceof String) 161069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project target.setParameter((String)me.getKey(), me.getValue()); 162069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 163069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 164069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 165069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 166