Home | History | Annotate | Download | only in cookie 
      1 /*
      2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/cookie/AbstractCookieSpec.java $
      3  * $Revision: 617207 $
      4  * $Date: 2008-01-31 12:14:12 -0800 (Thu, 31 Jan 2008) $
      5  *
      6  * ====================================================================
      7  * Licensed to the Apache Software Foundation (ASF) under one
      8  * or more contributor license agreements.  See the NOTICE file
      9  * distributed with this work for additional information
     10  * regarding copyright ownership.  The ASF licenses this file
     11  * to you under the Apache License, Version 2.0 (the
     12  * "License"); you may not use this file except in compliance
     13  * with the License.  You may obtain a copy of the License at
     14  *
     15  *   http://www.apache.org/licenses/LICENSE-2.0
     16  *
     17  * Unless required by applicable law or agreed to in writing,
     18  * software distributed under the License is distributed on an
     19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     20  * KIND, either express or implied.  See the License for the
     21  * specific language governing permissions and limitations
     22  * under the License.
     23  * ====================================================================
     24  *
     25  * This software consists of voluntary contributions made by many
     26  * individuals on behalf of the Apache Software Foundation.  For more
     27  * information on the Apache Software Foundation, please see
     28  * <http://www.apache.org/>.
     29  *
     30  */
     31 
     32 package org.apache.http.impl.cookie;
     33 
     34 import java.util.Collection;
     35 import java.util.HashMap;
     36 import java.util.Map;
     37 
     38 import org.apache.http.cookie.CookieAttributeHandler;
     39 import org.apache.http.cookie.CookieSpec;
     40 
     41 /**
     42  * Abstract cookie specification which can delegate the job of parsing,
     43  * validation or matching cookie attributes to a number of arbitrary
     44  * {@link CookieAttributeHandler}s.
     45  *
     46  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
     47  *
     48  * @since 4.0
     49  *
     50  * @deprecated Please use {@link java.net.URL#openConnection} instead.
     51  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
     52  *     for further details.
     53  */
     54 @Deprecated
     55 public abstract class AbstractCookieSpec implements CookieSpec {
     56 
     57     /**
     58     * Stores attribute name -> attribute handler mappings
     59     */
     60     private final Map<String, CookieAttributeHandler> attribHandlerMap;
     61 
     62     /**
     63      * Default constructor
     64      * */
     65     public AbstractCookieSpec() {
     66         super();
     67         this.attribHandlerMap = new HashMap<String, CookieAttributeHandler>(10);
     68     }
     69 
     70     public void registerAttribHandler(
     71             final String name, final CookieAttributeHandler handler) {
     72         if (name == null) {
     73             throw new IllegalArgumentException("Attribute name may not be null");
     74         }
     75         if (handler == null) {
     76             throw new IllegalArgumentException("Attribute handler may not be null");
     77         }
     78         this.attribHandlerMap.put(name, handler);
     79     }
     80 
     81     /**
     82      * Finds an attribute handler {@link CookieAttributeHandler} for the
     83      * given attribute. Returns <tt>null</tt> if no attribute handler is
     84      * found for the specified attribute.
     85      *
     86      * @param name attribute name. e.g. Domain, Path, etc.
     87      * @return an attribute handler or <tt>null</tt>
     88      */
     89     protected CookieAttributeHandler findAttribHandler(final String name) {
     90         return this.attribHandlerMap.get(name);
     91     }
     92 
     93     /**
     94      * Gets attribute handler {@link CookieAttributeHandler} for the
     95      * given attribute.
     96      *
     97      * @param name attribute name. e.g. Domain, Path, etc.
     98      * @throws IllegalStateException if handler not found for the
     99      *          specified attribute.
    100      */
    101     protected CookieAttributeHandler getAttribHandler(final String name) {
    102         CookieAttributeHandler handler = findAttribHandler(name);
    103         if (handler == null) {
    104             throw new IllegalStateException("Handler not registered for " +
    105                                             name + " attribute.");
    106         } else {
    107             return handler;
    108         }
    109     }
    110 
    111     protected Collection<CookieAttributeHandler> getAttribHandlers() {
    112         return this.attribHandlerMap.values();
    113     }
    114 
    115 }
    116