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