1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.http.auth.params;
29
30 import org.apache.http.annotation.Contract;
31 import org.apache.http.annotation.ThreadingBehavior;
32 import org.apache.http.params.HttpParams;
33 import org.apache.http.protocol.HTTP;
34 import org.apache.http.util.Args;
35
36 /**
37 * An adaptor for manipulating HTTP authentication parameters
38 * in {@link HttpParams}.
39 *
40 * @since 4.0
41 *
42 * @deprecated (4.3) use {@link org.apache.http.client.config.RequestConfig}
43 * and constructor parameters of
44 * {@link org.apache.http.auth.AuthSchemeProvider}s.
45 */
46 @Contract(threading = ThreadingBehavior.IMMUTABLE)
47 @Deprecated
48 public final class AuthParams {
49
50 private AuthParams() {
51 super();
52 }
53
54 /**
55 * Obtains the charset for encoding
56 * {@link org.apache.http.auth.Credentials}.If not configured,
57 * {@link HTTP#DEFAULT_PROTOCOL_CHARSET}is used instead.
58 *
59 * @return The charset
60 */
61 public static String getCredentialCharset(final HttpParams params) {
62 Args.notNull(params, "HTTP parameters");
63 String charset = (String) params.getParameter
64 (AuthPNames.CREDENTIAL_CHARSET);
65 if (charset == null) {
66 charset = HTTP.DEF_PROTOCOL_CHARSET.name();
67 }
68 return charset;
69 }
70
71
72 /**
73 * Sets the charset to be used when encoding
74 * {@link org.apache.http.auth.Credentials}.
75 *
76 * @param charset The charset
77 */
78 public static void setCredentialCharset(final HttpParams params, final String charset) {
79 Args.notNull(params, "HTTP parameters");
80 params.setParameter(AuthPNames.CREDENTIAL_CHARSET, charset);
81 }
82
83 }