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 import org.apache.http.auth.AuthSchemeProvider;
31 import org.apache.http.conn.socket.ConnectionSocketFactory;
32 import org.apache.http.cookie.CookieSpecProvider;
33
34 /**
35 * {@link org.apache.http.protocol.HttpContext} attribute names for
36 * client side HTTP protocol processing.
37 *
38 * @since 4.0
39 */
40 @Deprecated
41 public interface ClientContext {
42
43 /**
44 * Attribute name of a {@link org.apache.http.conn.routing.RouteInfo}
45 * object that represents the actual connection route.
46 *
47 * @since 4.3
48 */
49 public static final String ROUTE = "http.route";
50
51 /**
52 * Attribute name of a {@link org.apache.http.conn.scheme.Scheme}
53 * object that represents the actual protocol scheme registry.
54 *
55 * @deprecated (4.3) do not use
56 */
57 @Deprecated
58 public static final String SCHEME_REGISTRY = "http.scheme-registry";
59
60 /**
61 * Attribute name of a {@link org.apache.http.config.Lookup} object that represents
62 * the actual {@link CookieSpecProvider} registry.
63 */
64 public static final String COOKIESPEC_REGISTRY = "http.cookiespec-registry";
65
66 /**
67 * Attribute name of a {@link org.apache.http.cookie.CookieSpec}
68 * object that represents the actual cookie specification.
69 */
70 public static final String COOKIE_SPEC = "http.cookie-spec";
71
72 /**
73 * Attribute name of a {@link org.apache.http.cookie.CookieOrigin}
74 * object that represents the actual details of the origin server.
75 */
76 public static final String COOKIE_ORIGIN = "http.cookie-origin";
77
78 /**
79 * Attribute name of a {@link org.apache.http.client.CookieStore}
80 * object that represents the actual cookie store.
81 */
82 public static final String COOKIE_STORE = "http.cookie-store";
83
84 /**
85 * Attribute name of a {@link org.apache.http.client.CredentialsProvider}
86 * object that represents the actual credentials provider.
87 */
88 public static final String CREDS_PROVIDER = "http.auth.credentials-provider";
89
90 /**
91 * Attribute name of a {@link org.apache.http.client.AuthCache} object
92 * that represents the auth scheme cache.
93 */
94 public static final String AUTH_CACHE = "http.auth.auth-cache";
95
96 /**
97 * Attribute name of a {@link org.apache.http.auth.AuthState}
98 * object that represents the actual target authentication state.
99 */
100 public static final String TARGET_AUTH_STATE = "http.auth.target-scope";
101
102 /**
103 * Attribute name of a {@link org.apache.http.auth.AuthState}
104 * object that represents the actual proxy authentication state.
105 */
106 public static final String PROXY_AUTH_STATE = "http.auth.proxy-scope";
107
108 /**
109 * @deprecated (4.1) do not use
110 */
111 @Deprecated
112 public static final String AUTH_SCHEME_PREF = "http.auth.scheme-pref";
113
114 /**
115 * Attribute name of a {@link java.lang.Object} object that represents
116 * the actual user identity such as user {@link java.security.Principal}.
117 */
118 public static final String USER_TOKEN = "http.user-token";
119
120 /**
121 * Attribute name of a {@link org.apache.http.config.Lookup} object that represents
122 * the actual {@link AuthSchemeProvider} registry.
123 */
124 public static final String AUTHSCHEME_REGISTRY = "http.authscheme-registry";
125
126 /**
127 * Attribute name of a {@link org.apache.http.config.Lookup} object that represents
128 * the actual {@link ConnectionSocketFactory} registry.
129 *
130 * @since 4.3
131 */
132 public static final String SOCKET_FACTORY_REGISTRY = "http.socket-factory-registry";
133
134 /**
135 * Attribute name of a {@link org.apache.http.client.config.RequestConfig} object that
136 * represents the actual request configuration.
137 *
138 * @since 4.3
139 */
140 public static final String REQUEST_CONFIG = "http.request-config";
141
142 }