View Javadoc

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.Immutable;
31  import org.apache.http.params.HttpParams;
32  import org.apache.http.protocol.HTTP;
33  import org.apache.http.util.Args;
34  
35  /**
36   * An adaptor for manipulating HTTP authentication parameters
37   * in {@link HttpParams}.
38   *
39   * @since 4.0
40   *
41   * @deprecated (4.3) use {@link org.apache.http.client.config.RequestConfig}
42   *   and constructor parameters of
43   *   {@link org.apache.http.auth.AuthSchemeProvider}s.
44   */
45  @Immutable
46  @Deprecated
47  public final class AuthParams {
48  
49      private AuthParams() {
50          super();
51      }
52  
53      /**
54       * Obtains the charset for encoding
55       * {@link org.apache.http.auth.Credentials}.If not configured,
56       * {@link HTTP#DEFAULT_PROTOCOL_CHARSET}is used instead.
57       *
58       * @return The charset
59       */
60      public static String getCredentialCharset(final HttpParams params) {
61          Args.notNull(params, "HTTP parameters");
62          String charset = (String) params.getParameter
63              (AuthPNames.CREDENTIAL_CHARSET);
64          if (charset == null) {
65              charset = HTTP.DEF_PROTOCOL_CHARSET.name();
66          }
67          return charset;
68      }
69  
70  
71      /**
72       * Sets the charset to be used when encoding
73       * {@link org.apache.http.auth.Credentials}.
74       *
75       * @param charset The charset
76       */
77      public static void setCredentialCharset(final HttpParams params, final String charset) {
78          Args.notNull(params, "HTTP parameters");
79          params.setParameter(AuthPNames.CREDENTIAL_CHARSET, charset);
80      }
81  
82  }