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