mobile/android/thirdparty/ch/boye/httpclientandroidlib/auth/AuthSchemeRegistry.java@6474c204b198 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/auth/AuthSchemeRegistry.java
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* |
| michael@0 | 2 | * ==================================================================== |
| michael@0 | 3 | * |
| michael@0 | 4 | * Licensed to the Apache Software Foundation (ASF) under one or more |
| michael@0 | 5 | * contributor license agreements. See the NOTICE file distributed with |
| michael@0 | 6 | * this work for additional information regarding copyright ownership. |
| michael@0 | 7 | * The ASF licenses this file to You under the Apache License, Version 2.0 |
| michael@0 | 8 | * (the "License"); you may not use this file except in compliance with |
| michael@0 | 9 | * the License. You may obtain a copy of the License at |
| michael@0 | 10 | * |
| michael@0 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| michael@0 | 12 | * |
| michael@0 | 13 | * Unless required by applicable law or agreed to in writing, software |
| michael@0 | 14 | * distributed under the License is distributed on an "AS IS" BASIS, |
| michael@0 | 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| michael@0 | 16 | * See the License for the specific language governing permissions and |
| michael@0 | 17 | * limitations under the License. |
| michael@0 | 18 | * ==================================================================== |
| michael@0 | 19 | * |
| michael@0 | 20 | * This software consists of voluntary contributions made by many |
| michael@0 | 21 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 22 | * information on the Apache Software Foundation, please see |
| michael@0 | 23 | * <http://www.apache.org/>. |
| michael@0 | 24 | * |
| michael@0 | 25 | */ |
| michael@0 | 26 | |
| michael@0 | 27 | package ch.boye.httpclientandroidlib.auth; |
| michael@0 | 28 | |
| michael@0 | 29 | import java.util.ArrayList; |
| michael@0 | 30 | import java.util.List; |
| michael@0 | 31 | import java.util.Locale; |
| michael@0 | 32 | import java.util.Map; |
| michael@0 | 33 | import java.util.concurrent.ConcurrentHashMap; |
| michael@0 | 34 | |
| michael@0 | 35 | import ch.boye.httpclientandroidlib.annotation.ThreadSafe; |
| michael@0 | 36 | |
| michael@0 | 37 | import ch.boye.httpclientandroidlib.params.HttpParams; |
| michael@0 | 38 | |
| michael@0 | 39 | /** |
| michael@0 | 40 | * Authentication scheme registry that can be used to obtain the corresponding |
| michael@0 | 41 | * authentication scheme implementation for a given type of authorization challenge. |
| michael@0 | 42 | * |
| michael@0 | 43 | * @since 4.0 |
| michael@0 | 44 | */ |
| michael@0 | 45 | @ThreadSafe |
| michael@0 | 46 | public final class AuthSchemeRegistry { |
| michael@0 | 47 | |
| michael@0 | 48 | private final ConcurrentHashMap<String,AuthSchemeFactory> registeredSchemes; |
| michael@0 | 49 | |
| michael@0 | 50 | public AuthSchemeRegistry() { |
| michael@0 | 51 | super(); |
| michael@0 | 52 | this.registeredSchemes = new ConcurrentHashMap<String,AuthSchemeFactory>(); |
| michael@0 | 53 | } |
| michael@0 | 54 | |
| michael@0 | 55 | /** |
| michael@0 | 56 | * Registers a {@link AuthSchemeFactory} with the given identifier. If a factory with the |
| michael@0 | 57 | * given name already exists it will be overridden. This name is the same one used to |
| michael@0 | 58 | * retrieve the {@link AuthScheme authentication scheme} from {@link #getAuthScheme}. |
| michael@0 | 59 | * |
| michael@0 | 60 | * <p> |
| michael@0 | 61 | * Please note that custom authentication preferences, if used, need to be updated accordingly |
| michael@0 | 62 | * for the new {@link AuthScheme authentication scheme} to take effect. |
| michael@0 | 63 | * </p> |
| michael@0 | 64 | * |
| michael@0 | 65 | * @param name the identifier for this scheme |
| michael@0 | 66 | * @param factory the {@link AuthSchemeFactory} class to register |
| michael@0 | 67 | * |
| michael@0 | 68 | * @see #getAuthScheme |
| michael@0 | 69 | */ |
| michael@0 | 70 | public void register( |
| michael@0 | 71 | final String name, |
| michael@0 | 72 | final AuthSchemeFactory factory) { |
| michael@0 | 73 | if (name == null) { |
| michael@0 | 74 | throw new IllegalArgumentException("Name may not be null"); |
| michael@0 | 75 | } |
| michael@0 | 76 | if (factory == null) { |
| michael@0 | 77 | throw new IllegalArgumentException("Authentication scheme factory may not be null"); |
| michael@0 | 78 | } |
| michael@0 | 79 | registeredSchemes.put(name.toLowerCase(Locale.ENGLISH), factory); |
| michael@0 | 80 | } |
| michael@0 | 81 | |
| michael@0 | 82 | /** |
| michael@0 | 83 | * Unregisters the class implementing an {@link AuthScheme authentication scheme} with |
| michael@0 | 84 | * the given name. |
| michael@0 | 85 | * |
| michael@0 | 86 | * @param name the identifier of the class to unregister |
| michael@0 | 87 | */ |
| michael@0 | 88 | public void unregister(final String name) { |
| michael@0 | 89 | if (name == null) { |
| michael@0 | 90 | throw new IllegalArgumentException("Name may not be null"); |
| michael@0 | 91 | } |
| michael@0 | 92 | registeredSchemes.remove(name.toLowerCase(Locale.ENGLISH)); |
| michael@0 | 93 | } |
| michael@0 | 94 | |
| michael@0 | 95 | /** |
| michael@0 | 96 | * Gets the {@link AuthScheme authentication scheme} with the given name. |
| michael@0 | 97 | * |
| michael@0 | 98 | * @param name the {@link AuthScheme authentication scheme} identifier |
| michael@0 | 99 | * @param params the {@link HttpParams HTTP parameters} for the authentication |
| michael@0 | 100 | * scheme. |
| michael@0 | 101 | * |
| michael@0 | 102 | * @return {@link AuthScheme authentication scheme} |
| michael@0 | 103 | * |
| michael@0 | 104 | * @throws IllegalStateException if a scheme with the given name cannot be found |
| michael@0 | 105 | */ |
| michael@0 | 106 | public AuthScheme getAuthScheme(final String name, final HttpParams params) |
| michael@0 | 107 | throws IllegalStateException { |
| michael@0 | 108 | |
| michael@0 | 109 | if (name == null) { |
| michael@0 | 110 | throw new IllegalArgumentException("Name may not be null"); |
| michael@0 | 111 | } |
| michael@0 | 112 | AuthSchemeFactory factory = registeredSchemes.get(name.toLowerCase(Locale.ENGLISH)); |
| michael@0 | 113 | if (factory != null) { |
| michael@0 | 114 | return factory.newInstance(params); |
| michael@0 | 115 | } else { |
| michael@0 | 116 | throw new IllegalStateException("Unsupported authentication scheme: " + name); |
| michael@0 | 117 | } |
| michael@0 | 118 | } |
| michael@0 | 119 | |
| michael@0 | 120 | /** |
| michael@0 | 121 | * Obtains a list containing the names of all registered {@link AuthScheme authentication |
| michael@0 | 122 | * schemes} |
| michael@0 | 123 | * |
| michael@0 | 124 | * @return list of registered scheme names |
| michael@0 | 125 | */ |
| michael@0 | 126 | public List<String> getSchemeNames() { |
| michael@0 | 127 | return new ArrayList<String>(registeredSchemes.keySet()); |
| michael@0 | 128 | } |
| michael@0 | 129 | |
| michael@0 | 130 | /** |
| michael@0 | 131 | * Populates the internal collection of registered {@link AuthScheme authentication schemes} |
| michael@0 | 132 | * with the content of the map passed as a parameter. |
| michael@0 | 133 | * |
| michael@0 | 134 | * @param map authentication schemes |
| michael@0 | 135 | */ |
| michael@0 | 136 | public void setItems(final Map<String, AuthSchemeFactory> map) { |
| michael@0 | 137 | if (map == null) { |
| michael@0 | 138 | return; |
| michael@0 | 139 | } |
| michael@0 | 140 | registeredSchemes.clear(); |
| michael@0 | 141 | registeredSchemes.putAll(map); |
| michael@0 | 142 | } |
| michael@0 | 143 | |
| michael@0 | 144 | } |
