mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/cookie/AbstractCookieSpec.java

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

michael@0 1 /*
michael@0 2 * ====================================================================
michael@0 3 * Licensed to the Apache Software Foundation (ASF) under one
michael@0 4 * or more contributor license agreements. See the NOTICE file
michael@0 5 * distributed with this work for additional information
michael@0 6 * regarding copyright ownership. The ASF licenses this file
michael@0 7 * to you under the Apache License, Version 2.0 (the
michael@0 8 * "License"); you may not use this file except in compliance
michael@0 9 * with 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,
michael@0 14 * software distributed under the License is distributed on an
michael@0 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0 16 * KIND, either express or implied. See the License for the
michael@0 17 * specific language governing permissions and limitations
michael@0 18 * under the License.
michael@0 19 * ====================================================================
michael@0 20 *
michael@0 21 * This software consists of voluntary contributions made by many
michael@0 22 * individuals on behalf of the Apache Software Foundation. For more
michael@0 23 * information on the Apache Software Foundation, please see
michael@0 24 * <http://www.apache.org/>.
michael@0 25 *
michael@0 26 */
michael@0 27
michael@0 28 package ch.boye.httpclientandroidlib.impl.cookie;
michael@0 29
michael@0 30 import java.util.Collection;
michael@0 31 import java.util.HashMap;
michael@0 32 import java.util.Map;
michael@0 33
michael@0 34 import ch.boye.httpclientandroidlib.annotation.NotThreadSafe;
michael@0 35
michael@0 36 import ch.boye.httpclientandroidlib.cookie.CookieAttributeHandler;
michael@0 37 import ch.boye.httpclientandroidlib.cookie.CookieSpec;
michael@0 38
michael@0 39 /**
michael@0 40 * Abstract cookie specification which can delegate the job of parsing,
michael@0 41 * validation or matching cookie attributes to a number of arbitrary
michael@0 42 * {@link CookieAttributeHandler}s.
michael@0 43 *
michael@0 44 *
michael@0 45 * @since 4.0
michael@0 46 */
michael@0 47 @NotThreadSafe // HashMap is not thread-safe
michael@0 48 public abstract class AbstractCookieSpec implements CookieSpec {
michael@0 49
michael@0 50 /**
michael@0 51 * Stores attribute name -> attribute handler mappings
michael@0 52 */
michael@0 53 private final Map<String, CookieAttributeHandler> attribHandlerMap;
michael@0 54
michael@0 55 /**
michael@0 56 * Default constructor
michael@0 57 * */
michael@0 58 public AbstractCookieSpec() {
michael@0 59 super();
michael@0 60 this.attribHandlerMap = new HashMap<String, CookieAttributeHandler>(10);
michael@0 61 }
michael@0 62
michael@0 63 public void registerAttribHandler(
michael@0 64 final String name, final CookieAttributeHandler handler) {
michael@0 65 if (name == null) {
michael@0 66 throw new IllegalArgumentException("Attribute name may not be null");
michael@0 67 }
michael@0 68 if (handler == null) {
michael@0 69 throw new IllegalArgumentException("Attribute handler may not be null");
michael@0 70 }
michael@0 71 this.attribHandlerMap.put(name, handler);
michael@0 72 }
michael@0 73
michael@0 74 /**
michael@0 75 * Finds an attribute handler {@link CookieAttributeHandler} for the
michael@0 76 * given attribute. Returns <tt>null</tt> if no attribute handler is
michael@0 77 * found for the specified attribute.
michael@0 78 *
michael@0 79 * @param name attribute name. e.g. Domain, Path, etc.
michael@0 80 * @return an attribute handler or <tt>null</tt>
michael@0 81 */
michael@0 82 protected CookieAttributeHandler findAttribHandler(final String name) {
michael@0 83 return this.attribHandlerMap.get(name);
michael@0 84 }
michael@0 85
michael@0 86 /**
michael@0 87 * Gets attribute handler {@link CookieAttributeHandler} for the
michael@0 88 * given attribute.
michael@0 89 *
michael@0 90 * @param name attribute name. e.g. Domain, Path, etc.
michael@0 91 * @throws IllegalStateException if handler not found for the
michael@0 92 * specified attribute.
michael@0 93 */
michael@0 94 protected CookieAttributeHandler getAttribHandler(final String name) {
michael@0 95 CookieAttributeHandler handler = findAttribHandler(name);
michael@0 96 if (handler == null) {
michael@0 97 throw new IllegalStateException("Handler not registered for " +
michael@0 98 name + " attribute.");
michael@0 99 } else {
michael@0 100 return handler;
michael@0 101 }
michael@0 102 }
michael@0 103
michael@0 104 protected Collection<CookieAttributeHandler> getAttribHandlers() {
michael@0 105 return this.attribHandlerMap.values();
michael@0 106 }
michael@0 107
michael@0 108 }

mercurial