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