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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/*
* ====================================================================
* 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.params;
import java.nio.charset.CodingErrorAction;
import ch.boye.httpclientandroidlib.HttpVersion;
import ch.boye.httpclientandroidlib.ProtocolVersion;
import ch.boye.httpclientandroidlib.protocol.HTTP;
import ch.boye.httpclientandroidlib.util.Args;
/**
* Utility class for accessing protocol parameters in {@link HttpParams}.
*
* @since 4.0
*
* @deprecated (4.3) use configuration classes provided 'ch.boye.httpclientandroidlib.config'
* and 'ch.boye.httpclientandroidlib.client.config'
*/
@Deprecated
public final class HttpProtocolParams implements CoreProtocolPNames {
private HttpProtocolParams() {
super();
}
/**
* Obtains value of the {@link CoreProtocolPNames#HTTP_ELEMENT_CHARSET} parameter.
* If not set, defaults to <code>US-ASCII</code>.
*
* @param params HTTP parameters.
* @return HTTP element charset.
*/
public static String getHttpElementCharset(final HttpParams params) {
Args.notNull(params, "HTTP parameters");
String charset = (String) params.getParameter
(CoreProtocolPNames.HTTP_ELEMENT_CHARSET);
if (charset == null) {
charset = HTTP.DEF_PROTOCOL_CHARSET.name();
}
return charset;
}
/**
* Sets value of the {@link CoreProtocolPNames#HTTP_ELEMENT_CHARSET} parameter.
*
* @param params HTTP parameters.
* @param charset HTTP element charset.
*/
public static void setHttpElementCharset(final HttpParams params, final String charset) {
Args.notNull(params, "HTTP parameters");
params.setParameter(CoreProtocolPNames.HTTP_ELEMENT_CHARSET, charset);
}
/**
* Obtains value of the {@link CoreProtocolPNames#HTTP_CONTENT_CHARSET} parameter.
* If not set, defaults to <code>ISO-8859-1</code>.
*
* @param params HTTP parameters.
* @return HTTP content charset.
*/
public static String getContentCharset(final HttpParams params) {
Args.notNull(params, "HTTP parameters");
String charset = (String) params.getParameter
(CoreProtocolPNames.HTTP_CONTENT_CHARSET);
if (charset == null) {
charset = HTTP.DEF_CONTENT_CHARSET.name();
}
return charset;
}
/**
* Sets value of the {@link CoreProtocolPNames#HTTP_CONTENT_CHARSET} parameter.
*
* @param params HTTP parameters.
* @param charset HTTP content charset.
*/
public static void setContentCharset(final HttpParams params, final String charset) {
Args.notNull(params, "HTTP parameters");
params.setParameter(CoreProtocolPNames.HTTP_CONTENT_CHARSET, charset);
}
/**
* Obtains value of the {@link CoreProtocolPNames#PROTOCOL_VERSION} parameter.
* If not set, defaults to {@link HttpVersion#HTTP_1_1}.
*
* @param params HTTP parameters.
* @return HTTP protocol version.
*/
public static ProtocolVersion getVersion(final HttpParams params) {
Args.notNull(params, "HTTP parameters");
final Object param = params.getParameter
(CoreProtocolPNames.PROTOCOL_VERSION);
if (param == null) {
return HttpVersion.HTTP_1_1;
}
return (ProtocolVersion)param;
}
/**
* Sets value of the {@link CoreProtocolPNames#PROTOCOL_VERSION} parameter.
*
* @param params HTTP parameters.
* @param version HTTP protocol version.
*/
public static void setVersion(final HttpParams params, final ProtocolVersion version) {
Args.notNull(params, "HTTP parameters");
params.setParameter(CoreProtocolPNames.PROTOCOL_VERSION, version);
}
/**
* Obtains value of the {@link CoreProtocolPNames#USER_AGENT} parameter.
* If not set, returns <code>null</code>.
*
* @param params HTTP parameters.
* @return User agent string.
*/
public static String getUserAgent(final HttpParams params) {
Args.notNull(params, "HTTP parameters");
return (String) params.getParameter(CoreProtocolPNames.USER_AGENT);
}
/**
* Sets value of the {@link CoreProtocolPNames#USER_AGENT} parameter.
*
* @param params HTTP parameters.
* @param useragent User agent string.
*/
public static void setUserAgent(final HttpParams params, final String useragent) {
Args.notNull(params, "HTTP parameters");
params.setParameter(CoreProtocolPNames.USER_AGENT, useragent);
}
/**
* Obtains value of the {@link CoreProtocolPNames#USE_EXPECT_CONTINUE} parameter.
* If not set, returns <code>false</code>.
*
* @param params HTTP parameters.
* @return User agent string.
*/
public static boolean useExpectContinue(final HttpParams params) {
Args.notNull(params, "HTTP parameters");
return params.getBooleanParameter(CoreProtocolPNames.USE_EXPECT_CONTINUE, false);
}
/**
* Sets value of the {@link CoreProtocolPNames#USE_EXPECT_CONTINUE} parameter.
*
* @param params HTTP parameters.
* @param b expect-continue flag.
*/
public static void setUseExpectContinue(final HttpParams params, final boolean b) {
Args.notNull(params, "HTTP parameters");
params.setBooleanParameter(CoreProtocolPNames.USE_EXPECT_CONTINUE, b);
}
/**
* Obtains value of the {@link CoreProtocolPNames#HTTP_MALFORMED_INPUT_ACTION} parameter.
* @param params HTTP parameters.
* @return Action to perform upon receiving a malformed input
*
* @since 4.2
*/
public static CodingErrorAction getMalformedInputAction(final HttpParams params) {
Args.notNull(params, "HTTP parameters");
final Object param = params.getParameter(CoreProtocolPNames.HTTP_MALFORMED_INPUT_ACTION);
if (param == null) {
// the default CodingErrorAction
return CodingErrorAction.REPORT;
}
return (CodingErrorAction) param;
}
/**
* Sets value of the {@link CoreProtocolPNames#HTTP_MALFORMED_INPUT_ACTION} parameter.
* @param params HTTP parameters
* @param action action to perform on malformed inputs
*
* @since 4.2
*/
public static void setMalformedInputAction(final HttpParams params, final CodingErrorAction action) {
Args.notNull(params, "HTTP parameters");
params.setParameter(CoreProtocolPNames.HTTP_MALFORMED_INPUT_ACTION, action);
}
/**
* Obtains the value of the {@link CoreProtocolPNames#HTTP_UNMAPPABLE_INPUT_ACTION} parameter.
* @param params HTTP parameters
* @return Action to perform upon receiving a unmapped input
*
* @since 4.2
*/
public static CodingErrorAction getUnmappableInputAction(final HttpParams params) {
Args.notNull(params, "HTTP parameters");
final Object param = params.getParameter(CoreProtocolPNames.HTTP_UNMAPPABLE_INPUT_ACTION);
if (param == null) {
// the default CodingErrorAction
return CodingErrorAction.REPORT;
}
return (CodingErrorAction) param;
}
/**
* Sets the value of the {@link CoreProtocolPNames#HTTP_UNMAPPABLE_INPUT_ACTION} parameter.
* @param params HTTP parameters
* @param action action to perform on un mappable inputs
*
* @since 4.2
*/
public static void setUnmappableInputAction(final HttpParams params, final CodingErrorAction action) {
Args.notNull(params, "HTTP parameters");
params.setParameter(CoreProtocolPNames.HTTP_UNMAPPABLE_INPUT_ACTION, action);
}
}
|
