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.auth.AuthScheme;
31  import org.apache.http.auth.AuthSchemeProvider;
32  import org.apache.http.client.config.RequestConfig;
33  
34  /**
35   * Parameter names for HTTP authentication classes.
36   *
37   * @since 4.0
38   *
39   * @deprecated (4.3) use {@link RequestConfig} and constructor parameters of
40   *   {@link AuthSchemeProvider}s.
41  */
42  @Deprecated
43  public interface AuthPNames {
44  
45      /**
46       * Defines the charset to be used when encoding
47       * {@link org.apache.http.auth.Credentials}.
48       * <p>
49       * This parameter expects a value of type {@link String}.
50       */
51      public static final String CREDENTIAL_CHARSET = "http.auth.credential-charset";
52  
53      /**
54       * Defines the order of preference for supported {@link AuthScheme}s when
55       * authenticating with the target host.
56       * <p>
57       * This parameter expects a value of type {@link java.util.Collection}. The
58       * collection is expected to contain {@link String} instances representing
59       * a name of an authentication scheme as returned by
60       * {@link AuthScheme#getSchemeName()}.
61       */
62      public static final String TARGET_AUTH_PREF = "http.auth.target-scheme-pref";
63  
64      /**
65       * Defines the order of preference for supported {@link AuthScheme}s when
66       * authenticating with the proxy host.
67       * <p>
68       * This parameter expects a value of type {@link java.util.Collection}. The
69       * collection is expected to contain {@link String} instances representing
70       * a name of an authentication scheme as returned by
71       * {@link AuthScheme#getSchemeName()}.
72       */
73      public static final String PROXY_AUTH_PREF = "http.auth.proxy-scheme-pref";
74  
75  }