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/conn/scheme/SchemeRegistry.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 648356 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-04-15 10:57:53 -0700 (Tue, 15 Apr 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 Projectpackage org.apache.http.conn.scheme; 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.ArrayList; 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.LinkedHashMap; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.List; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.Map; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.HttpHost; 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * A set of supported protocol {@link Scheme schemes}. 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Schemes are identified by lowercase names. 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:rolandw at apache.org">Roland Weber</a> 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <!-- empty lines to avoid svn diff problems --> 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 648356 $ $Date: 2008-04-15 10:57:53 -0700 (Tue, 15 Apr 2008) $ 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic final class SchemeRegistry { 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** The available schemes in this registry. */ 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private final Map<String,Scheme> registeredSchemes; 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Creates a new, empty scheme registry. 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public SchemeRegistry() { 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(); 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project registeredSchemes = new LinkedHashMap<String,Scheme>(); 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Obtains a scheme by name. 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param name the name of the scheme to look up (in lowercase) 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the scheme, never <code>null</code> 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws IllegalStateException 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * if the scheme with the given name is not registered 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized final Scheme getScheme(String name) { 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Scheme found = get(name); 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (found == null) { 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalStateException 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ("Scheme '"+name+"' not registered."); 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return found; 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Obtains the scheme for a host. 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Convenience method for <code>getScheme(host.getSchemeName())</pre> 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param host the host for which to obtain the scheme 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the scheme for the given host, never <code>null</code> 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws IllegalStateException 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * if a scheme with the respective name is not registered 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized final Scheme getScheme(HttpHost host) { 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (host == null) { 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Host must not be null."); 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return getScheme(host.getSchemeName()); 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Obtains a scheme by name, if registered. 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param name the name of the scheme to look up (in lowercase) 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the scheme, or 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>null</code> if there is none by this name 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized final Scheme get(String name) { 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (name == null) 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Name must not be null."); 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // leave it to the caller to use the correct name - all lowercase 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project //name = name.toLowerCase(); 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Scheme found = registeredSchemes.get(name); 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return found; 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Registers a scheme. 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The scheme can later be retrieved by its name 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * using {@link #getScheme(String) getScheme} or {@link #get get}. 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param sch the scheme to register 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the scheme previously registered with that name, or 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>null</code> if none was registered 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized final Scheme register(Scheme sch) { 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (sch == null) 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Scheme must not be null."); 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Scheme old = registeredSchemes.put(sch.getName(), sch); 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return old; 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unregisters a scheme. 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param name the name of the scheme to unregister (in lowercase) 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the unregistered scheme, or 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>null</code> if there was none 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 152069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized final Scheme unregister(String name) { 153069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (name == null) 154069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Name must not be null."); 155069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 156069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // leave it to the caller to use the correct name - all lowercase 157069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project //name = name.toLowerCase(); 158069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Scheme gone = registeredSchemes.remove(name); 159069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return gone; 160069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 161069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 162069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 163069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 164069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Obtains the names of the registered schemes in their default order. 165069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 166069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return List containing registered scheme names. 167069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 168069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized final List<String> getSchemeNames() { 169069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return new ArrayList<String>(registeredSchemes.keySet()); 170069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 171069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 172069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 173069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Populates the internal collection of registered {@link Scheme protocol schemes} 174069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with the content of the map passed as a parameter. 175069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 176069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param map protocol schemes 177069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 178069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized void setItems(final Map<String, Scheme> map) { 179069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (map == null) { 180069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return; 181069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 182069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project registeredSchemes.clear(); 183069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project registeredSchemes.putAll(map); 184069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 185069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 186069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} // class SchemeRegistry 187069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 188