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.client.protocol;
29
30 /**
31 * {@link org.apache.http.protocol.HttpContext} attribute names for
32 * client side HTTP protocol processing.
33 *
34 * @since 4.0
35 */
36 public interface ClientContext {
37
38 /**
39 * Attribute name of a {@link org.apache.http.conn.scheme.Scheme}
40 * object that represents the actual protocol scheme registry.
41 */
42 public static final String SCHEME_REGISTRY = "http.scheme-registry";
43 /**
44 * Attribute name of a {@link org.apache.http.cookie.CookieSpecRegistry}
45 * object that represents the actual cookie specification registry.
46 */
47 public static final String COOKIESPEC_REGISTRY = "http.cookiespec-registry";
48
49 /**
50 * Attribute name of a {@link org.apache.http.cookie.CookieSpec}
51 * object that represents the actual cookie specification.
52 */
53 public static final String COOKIE_SPEC = "http.cookie-spec";
54
55 /**
56 * Attribute name of a {@link org.apache.http.cookie.CookieOrigin}
57 * object that represents the actual details of the origin server.
58 */
59 public static final String COOKIE_ORIGIN = "http.cookie-origin";
60
61 /**
62 * Attribute name of a {@link org.apache.http.client.CookieStore}
63 * object that represents the actual cookie store.
64 */
65 public static final String COOKIE_STORE = "http.cookie-store";
66
67 /**
68 * Attribute name of a {@link org.apache.http.auth.AuthSchemeRegistry}
69 * object that represents the actual authentication scheme registry.
70 */
71 public static final String AUTHSCHEME_REGISTRY = "http.authscheme-registry";
72
73 /**
74 * Attribute name of a {@link org.apache.http.client.CredentialsProvider}
75 * object that represents the actual credentials provider.
76 */
77 public static final String CREDS_PROVIDER = "http.auth.credentials-provider";
78
79 /**
80 * Attribute name of a {@link org.apache.http.client.AuthCache} object
81 * that represents the auth scheme cache.
82 */
83 public static final String AUTH_CACHE = "http.auth.auth-cache";
84
85 /**
86 * Attribute name of a {@link org.apache.http.auth.AuthState}
87 * object that represents the actual target authentication state.
88 */
89 public static final String TARGET_AUTH_STATE = "http.auth.target-scope";
90
91 /**
92 * Attribute name of a {@link org.apache.http.auth.AuthState}
93 * object that represents the actual proxy authentication state.
94 */
95 public static final String PROXY_AUTH_STATE = "http.auth.proxy-scope";
96
97 /**
98 * @deprecated (4.1) do not use
99 */
100 @Deprecated
101 public static final String AUTH_SCHEME_PREF = "http.auth.scheme-pref";
102
103 /**
104 * Attribute name of a {@link java.lang.Object} object that represents
105 * the actual user identity such as user {@link java.security.Principal}.
106 */
107 public static final String USER_TOKEN = "http.user-token";
108
109 }