1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package ch.boye.httpclientandroidlib.cookie;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import ch.boye.httpclientandroidlib.HttpRequest;
import ch.boye.httpclientandroidlib.annotation.ThreadSafe;
import ch.boye.httpclientandroidlib.config.Lookup;
import ch.boye.httpclientandroidlib.params.HttpParams;
import ch.boye.httpclientandroidlib.protocol.ExecutionContext;
import ch.boye.httpclientandroidlib.protocol.HttpContext;
import ch.boye.httpclientandroidlib.util.Args;
/**
* Cookie specification registry that can be used to obtain the corresponding
* cookie specification implementation for a given type of type or version of
* cookie.
*
* @since 4.0
*
* @deprecated (4.3) use {@link ch.boye.httpclientandroidlib.config.Registry}.
*/
@ThreadSafe
@Deprecated
public final class CookieSpecRegistry implements Lookup<CookieSpecProvider> {
private final ConcurrentHashMap<String,CookieSpecFactory> registeredSpecs;
public CookieSpecRegistry() {
super();
this.registeredSpecs = new ConcurrentHashMap<String,CookieSpecFactory>();
}
/**
* Registers a {@link CookieSpecFactory} with the given identifier.
* If a specification with the given name already exists it will be overridden.
* This nameis the same one used to retrieve the {@link CookieSpecFactory}
* from {@link #getCookieSpec(String)}.
*
* @param name the identifier for this specification
* @param factory the {@link CookieSpecFactory} class to register
*
* @see #getCookieSpec(String)
*/
public void register(final String name, final CookieSpecFactory factory) {
Args.notNull(name, "Name");
Args.notNull(factory, "Cookie spec factory");
registeredSpecs.put(name.toLowerCase(Locale.ENGLISH), factory);
}
/**
* Unregisters the {@link CookieSpecFactory} with the given ID.
*
* @param id the identifier of the {@link CookieSpec cookie specification} to unregister
*/
public void unregister(final String id) {
Args.notNull(id, "Id");
registeredSpecs.remove(id.toLowerCase(Locale.ENGLISH));
}
/**
* Gets the {@link CookieSpec cookie specification} with the given ID.
*
* @param name the {@link CookieSpec cookie specification} identifier
* @param params the {@link HttpParams HTTP parameters} for the cookie
* specification.
*
* @return {@link CookieSpec cookie specification}
*
* @throws IllegalStateException if a policy with the given name cannot be found
*/
public CookieSpec getCookieSpec(final String name, final HttpParams params)
throws IllegalStateException {
Args.notNull(name, "Name");
final CookieSpecFactory factory = registeredSpecs.get(name.toLowerCase(Locale.ENGLISH));
if (factory != null) {
return factory.newInstance(params);
} else {
throw new IllegalStateException("Unsupported cookie spec: " + name);
}
}
/**
* Gets the {@link CookieSpec cookie specification} with the given name.
*
* @param name the {@link CookieSpec cookie specification} identifier
*
* @return {@link CookieSpec cookie specification}
*
* @throws IllegalStateException if a policy with the given name cannot be found
*/
public CookieSpec getCookieSpec(final String name)
throws IllegalStateException {
return getCookieSpec(name, null);
}
/**
* Obtains a list containing the names of all registered {@link CookieSpec cookie
* specs}.
*
* Note that the DEFAULT policy (if present) is likely to be the same
* as one of the other policies, but does not have to be.
*
* @return list of registered cookie spec names
*/
public List<String> getSpecNames(){
return new ArrayList<String>(registeredSpecs.keySet());
}
/**
* Populates the internal collection of registered {@link CookieSpec cookie
* specs} with the content of the map passed as a parameter.
*
* @param map cookie specs
*/
public void setItems(final Map<String, CookieSpecFactory> map) {
if (map == null) {
return;
}
registeredSpecs.clear();
registeredSpecs.putAll(map);
}
public CookieSpecProvider lookup(final String name) {
return new CookieSpecProvider() {
public CookieSpec create(final HttpContext context) {
final HttpRequest request = (HttpRequest) context.getAttribute(
ExecutionContext.HTTP_REQUEST);
return getCookieSpec(name, request.getParams());
}
};
}
}
|
