AbstractCookieSpec.java revision 069490a5ca2fd1988d29daf45d892f47ad665115 
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
32package org.apache.http.impl.cookie;
33
34import java.util.Collection;
35import java.util.HashMap;
36import java.util.Map;
37
38import org.apache.http.cookie.CookieAttributeHandler;
39import 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 */
50public abstract class AbstractCookieSpec implements CookieSpec {
51
52    /**
53    * Stores attribute name -> attribute handler mappings
54    */
55    private final Map<String, CookieAttributeHandler> attribHandlerMap;
56
57    /**
58     * Default constructor
59     * */
60    public AbstractCookieSpec() {
61        super();
62        this.attribHandlerMap = new HashMap<String, CookieAttributeHandler>(10);
63    }
64
65    public void registerAttribHandler(
66            final String name, final CookieAttributeHandler handler) {
67        if (name == null) {
68            throw new IllegalArgumentException("Attribute name may not be null");
69        }
70        if (handler == null) {
71            throw new IllegalArgumentException("Attribute handler may not be null");
72        }
73        this.attribHandlerMap.put(name, handler);
74    }
75
76    /**
77     * Finds an attribute handler {@link CookieAttributeHandler} for the
78     * given attribute. Returns <tt>null</tt> if no attribute handler is
79     * found for the specified attribute.
80     *
81     * @param name attribute name. e.g. Domain, Path, etc.
82     * @return an attribute handler or <tt>null</tt>
83     */
84    protected CookieAttributeHandler findAttribHandler(final String name) {
85        return this.attribHandlerMap.get(name);
86    }
87
88    /**
89     * Gets attribute handler {@link CookieAttributeHandler} for the
90     * given attribute.
91     *
92     * @param name attribute name. e.g. Domain, Path, etc.
93     * @throws IllegalStateException if handler not found for the
94     *          specified attribute.
95     */
96    protected CookieAttributeHandler getAttribHandler(final String name) {
97        CookieAttributeHandler handler = findAttribHandler(name);
98        if (handler == null) {
99            throw new IllegalStateException("Handler not registered for " +
100                                            name + " attribute.");
101        } else {
102            return handler;
103        }
104    }
105
106    protected Collection<CookieAttributeHandler> getAttribHandlers() {
107        return this.attribHandlerMap.values();
108    }
109
110}
111