1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/client/BasicCredentialsProvider.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 653041 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-05-03 03:39:28 -0700 (Sat, 03 May 2008) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * this work for additional information regarding copyright ownership. 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * (the "License"); you may not use this file except in compliance with 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 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, software 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * See the License for the specific language governing permissions and 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * limitations under the License. 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.impl.client; 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.HashMap; 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.AuthScope; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.auth.Credentials; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.client.CredentialsProvider; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Default implementation of {@link CredentialsProvider} 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:remm@apache.org">Remy Maucherat</a> 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author Rodney Waldhoff 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a> 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author Sean C. Sullivan 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:becke@u.washington.edu">Michael Becke</a> 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a> 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:adrian@intencha.com">Adrian Sutton</a> 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 52d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * 53d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * @deprecated Please use {@link java.net.URL#openConnection} instead. 54d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 55d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * for further details. 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 57d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath@Deprecated 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic class BasicCredentialsProvider implements CredentialsProvider { 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private final HashMap<AuthScope, Credentials> credMap; 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Default constructor. 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public BasicCredentialsProvider() { 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(); 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.credMap = new HashMap<AuthScope, Credentials>(); 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Sets the {@link Credentials credentials} for the given authentication 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * scope. Any previous credentials for the given scope will be overwritten. 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param authscope the {@link AuthScope authentication scope} 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param credentials the authentication {@link Credentials credentials} 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * for the given scope. 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #getCredentials(AuthScope) 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized void setCredentials( 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project final AuthScope authscope, 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project final Credentials credentials) { 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (authscope == null) { 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Authentication scope may not be null"); 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project credMap.put(authscope, credentials); 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Find matching {@link Credentials credentials} for the given authentication scope. 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param map the credentials hash map 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param authscope the {@link AuthScope authentication scope} 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the credentials 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private static Credentials matchCredentials( 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project final HashMap<AuthScope, Credentials> map, 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project final AuthScope authscope) { 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // see if we get a direct hit 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Credentials creds = map.get(authscope); 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (creds == null) { 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // Nope. 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // Do a full scan 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int bestMatchFactor = -1; 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project AuthScope bestMatch = null; 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project for (AuthScope current: map.keySet()) { 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int factor = authscope.match(current); 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (factor > bestMatchFactor) { 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project bestMatchFactor = factor; 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project bestMatch = current; 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (bestMatch != null) { 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project creds = map.get(bestMatch); 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return creds; 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Get the {@link Credentials credentials} for the given authentication scope. 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param authscope the {@link AuthScope authentication scope} 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the credentials 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #setCredentials(AuthScope, Credentials) 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized Credentials getCredentials(final AuthScope authscope) { 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (authscope == null) { 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Authentication scope may not be null"); 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return matchCredentials(this.credMap, authscope); 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project @Override 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public String toString() { 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return credMap.toString(); 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Clears all credentials. 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized void clear() { 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.credMap.clear(); 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 149