• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/UserTokenHandler.java $
3  * $Revision: 658759 $
4  * $Date: 2008-05-21 10:06:17 -0700 (Wed, 21 May 2008) $
5  *
6  * ====================================================================
7  * Licensed to the Apache Software Foundation (ASF) under one
8  * or more contributor license agreements.  See the NOTICE file
9  * distributed with this work for additional information
10  * regarding copyright ownership.  The ASF licenses this file
11  * to you under the Apache License, Version 2.0 (the
12  * "License"); you may not use this file except in compliance
13  * with the License.  You may obtain a copy of the License at
14  *
15  *   http://www.apache.org/licenses/LICENSE-2.0
16  *
17  * Unless required by applicable law or agreed to in writing,
18  * software distributed under the License is distributed on an
19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20  * KIND, either express or implied.  See the License for the
21  * specific language governing permissions and limitations
22  * under the License.
23  * ====================================================================
24  *
25  * This software consists of voluntary contributions made by many
26  * individuals on behalf of the Apache Software Foundation.  For more
27  * information on the Apache Software Foundation, please see
28  * <http://www.apache.org/>.
29  *
30  */
31 
32 package org.apache.http.client;
33 
34 import org.apache.http.protocol.HttpContext;
35 
36 /**
37  * A handler for determining if the given execution context is user specific
38  * or not. The token object returned by this handler is expected to uniquely
39  * identify the current user if the context is user specific or to be
40  * <code>null</code> if the context does not contain any resources or details
41  * specific to the current user.
42  * <p/>
43  * The user token will be used to ensure that user specific resouces will not
44  * shared with or reused by other users.
45  *
46  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
47  *
48  * @since 4.0
49  *
50  * @deprecated Please use {@link java.net.URL#openConnection} instead.
51  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
52  *     for further details.
53  */
54 @Deprecated
55 public interface UserTokenHandler {
56 
57     /**
58      * The token object returned by this method is expected to uniquely
59      * identify the current user if the context is user specific or to be
60      * <code>null</code> if it is not.
61      *
62      * @param context the execution context
63      *
64      * @return user token that uniquely identifies the user or
65      * <code>null</null> if the context is not user specific.
66      */
getUserToken(HttpContext context)67     Object getUserToken(HttpContext context);
68 
69 }
70