Wed, 31 Dec 2014 07:22:50 +0100
Correct previous dual key logic pending first delivery installment.
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.impl.auth; |
michael@0 | 28 | |
michael@0 | 29 | import java.util.HashMap; |
michael@0 | 30 | import java.util.Locale; |
michael@0 | 31 | import java.util.Map; |
michael@0 | 32 | |
michael@0 | 33 | import ch.boye.httpclientandroidlib.annotation.NotThreadSafe; |
michael@0 | 34 | |
michael@0 | 35 | import ch.boye.httpclientandroidlib.HeaderElement; |
michael@0 | 36 | import ch.boye.httpclientandroidlib.auth.MalformedChallengeException; |
michael@0 | 37 | import ch.boye.httpclientandroidlib.message.BasicHeaderValueParser; |
michael@0 | 38 | import ch.boye.httpclientandroidlib.message.HeaderValueParser; |
michael@0 | 39 | import ch.boye.httpclientandroidlib.message.ParserCursor; |
michael@0 | 40 | import ch.boye.httpclientandroidlib.util.CharArrayBuffer; |
michael@0 | 41 | |
michael@0 | 42 | /** |
michael@0 | 43 | * Abstract authentication scheme class that lays foundation for all |
michael@0 | 44 | * RFC 2617 compliant authentication schemes and provides capabilities common |
michael@0 | 45 | * to all authentication schemes defined in RFC 2617. |
michael@0 | 46 | * |
michael@0 | 47 | * @since 4.0 |
michael@0 | 48 | */ |
michael@0 | 49 | @NotThreadSafe // AuthSchemeBase, params |
michael@0 | 50 | public abstract class RFC2617Scheme extends AuthSchemeBase { |
michael@0 | 51 | |
michael@0 | 52 | /** |
michael@0 | 53 | * Authentication parameter map. |
michael@0 | 54 | */ |
michael@0 | 55 | private Map<String, String> params; |
michael@0 | 56 | |
michael@0 | 57 | /** |
michael@0 | 58 | * Default constructor for RFC2617 compliant authentication schemes. |
michael@0 | 59 | */ |
michael@0 | 60 | public RFC2617Scheme() { |
michael@0 | 61 | super(); |
michael@0 | 62 | } |
michael@0 | 63 | |
michael@0 | 64 | @Override |
michael@0 | 65 | protected void parseChallenge( |
michael@0 | 66 | final CharArrayBuffer buffer, int pos, int len) throws MalformedChallengeException { |
michael@0 | 67 | HeaderValueParser parser = BasicHeaderValueParser.DEFAULT; |
michael@0 | 68 | ParserCursor cursor = new ParserCursor(pos, buffer.length()); |
michael@0 | 69 | HeaderElement[] elements = parser.parseElements(buffer, cursor); |
michael@0 | 70 | if (elements.length == 0) { |
michael@0 | 71 | throw new MalformedChallengeException("Authentication challenge is empty"); |
michael@0 | 72 | } |
michael@0 | 73 | |
michael@0 | 74 | this.params = new HashMap<String, String>(elements.length); |
michael@0 | 75 | for (HeaderElement element : elements) { |
michael@0 | 76 | this.params.put(element.getName(), element.getValue()); |
michael@0 | 77 | } |
michael@0 | 78 | } |
michael@0 | 79 | |
michael@0 | 80 | /** |
michael@0 | 81 | * Returns authentication parameters map. Keys in the map are lower-cased. |
michael@0 | 82 | * |
michael@0 | 83 | * @return the map of authentication parameters |
michael@0 | 84 | */ |
michael@0 | 85 | protected Map<String, String> getParameters() { |
michael@0 | 86 | if (this.params == null) { |
michael@0 | 87 | this.params = new HashMap<String, String>(); |
michael@0 | 88 | } |
michael@0 | 89 | return this.params; |
michael@0 | 90 | } |
michael@0 | 91 | |
michael@0 | 92 | /** |
michael@0 | 93 | * Returns authentication parameter with the given name, if available. |
michael@0 | 94 | * |
michael@0 | 95 | * @param name The name of the parameter to be returned |
michael@0 | 96 | * |
michael@0 | 97 | * @return the parameter with the given name |
michael@0 | 98 | */ |
michael@0 | 99 | public String getParameter(final String name) { |
michael@0 | 100 | if (name == null) { |
michael@0 | 101 | throw new IllegalArgumentException("Parameter name may not be null"); |
michael@0 | 102 | } |
michael@0 | 103 | if (this.params == null) { |
michael@0 | 104 | return null; |
michael@0 | 105 | } |
michael@0 | 106 | return this.params.get(name.toLowerCase(Locale.ENGLISH)); |
michael@0 | 107 | } |
michael@0 | 108 | |
michael@0 | 109 | /** |
michael@0 | 110 | * Returns authentication realm. The realm may not be null. |
michael@0 | 111 | * |
michael@0 | 112 | * @return the authentication realm |
michael@0 | 113 | */ |
michael@0 | 114 | public String getRealm() { |
michael@0 | 115 | return getParameter("realm"); |
michael@0 | 116 | } |
michael@0 | 117 | |
michael@0 | 118 | } |