|
5
|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
|
2 <!--NewPage-->
|
|
|
3 <HTML>
|
|
|
4 <HEAD>
|
|
|
5 <!-- Generated by javadoc (build 1.5.0_11) on Sat Aug 23 11:49:48 GMT+01:00 2008 -->
|
|
|
6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
|
7 <TITLE>
|
|
|
8 UserTokenHandler (HttpClient 4.0-beta1 API)
|
|
|
9 </TITLE>
|
|
|
10
|
|
|
11 <META NAME="keywords" CONTENT="org.apache.http.client.UserTokenHandler interface">
|
|
|
12
|
|
|
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
|
|
|
14
|
|
|
15 <SCRIPT type="text/javascript">
|
|
|
16 function windowTitle()
|
|
|
17 {
|
|
|
18 parent.document.title="UserTokenHandler (HttpClient 4.0-beta1 API)";
|
|
|
19 }
|
|
|
20 </SCRIPT>
|
|
|
21 <NOSCRIPT>
|
|
|
22 </NOSCRIPT>
|
|
|
23
|
|
|
24 </HEAD>
|
|
|
25
|
|
|
26 <BODY BGCOLOR="white" onload="windowTitle();">
|
|
|
27
|
|
|
28
|
|
|
29 <!-- ========= START OF TOP NAVBAR ======= -->
|
|
|
30 <A NAME="navbar_top"><!-- --></A>
|
|
|
31 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
|
32 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
33 <TR>
|
|
|
34 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
35 <A NAME="navbar_top_firstrow"><!-- --></A>
|
|
|
36 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
37 <TR ALIGN="center" VALIGN="top">
|
|
|
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
|
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
40 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/UserTokenHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
46 </TR>
|
|
|
47 </TABLE>
|
|
|
48 </TD>
|
|
|
49 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
50 </EM>
|
|
|
51 </TD>
|
|
|
52 </TR>
|
|
|
53
|
|
|
54 <TR>
|
|
|
55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
56 <A HREF="../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client"><B>PREV CLASS</B></A>
|
|
|
57 NEXT CLASS</FONT></TD>
|
|
|
58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
59 <A HREF="../../../../index.html?org/apache/http/client/UserTokenHandler.html" target="_top"><B>FRAMES</B></A>
|
|
|
60 <A HREF="UserTokenHandler.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
61 <SCRIPT type="text/javascript">
|
|
|
62 <!--
|
|
|
63 if(window==top) {
|
|
|
64 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
65 }
|
|
|
66 //-->
|
|
|
67 </SCRIPT>
|
|
|
68 <NOSCRIPT>
|
|
|
69 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
70 </NOSCRIPT>
|
|
|
71
|
|
|
72
|
|
|
73 </FONT></TD>
|
|
|
74 </TR>
|
|
|
75 <TR>
|
|
|
76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
77 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
79 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
|
80 </TR>
|
|
|
81 </TABLE>
|
|
|
82 <A NAME="skip-navbar_top"></A>
|
|
|
83 <!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
84
|
|
|
85 <HR>
|
|
|
86 <!-- ======== START OF CLASS DATA ======== -->
|
|
|
87 <H2>
|
|
|
88 <FONT SIZE="-1">
|
|
|
89 org.apache.http.client</FONT>
|
|
|
90 <BR>
|
|
|
91 Interface UserTokenHandler</H2>
|
|
|
92 <DL>
|
|
|
93 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/http/impl/client/DefaultUserTokenHandler.html" title="class in org.apache.http.impl.client">DefaultUserTokenHandler</A></DD>
|
|
|
94 </DL>
|
|
|
95 <HR>
|
|
|
96 <DL>
|
|
|
97 <DT><PRE>public interface <B>UserTokenHandler</B></DL>
|
|
|
98 </PRE>
|
|
|
99
|
|
|
100 <P>
|
|
|
101 A handler for determining if the given execution context is user specific
|
|
|
102 or not. The token object returned by this handler is expected to uniquely
|
|
|
103 identify the current user if the context is user specific or to be
|
|
|
104 <code>null</code> if the context does not contain any resources or details
|
|
|
105 specific to the current user.
|
|
|
106 <p/>
|
|
|
107 The user token will be used to ensure that user specific resouces will not
|
|
|
108 shared with or reused by other users.
|
|
|
109 <P>
|
|
|
110
|
|
|
111 <P>
|
|
|
112 <DL>
|
|
|
113 <DT><B>Since:</B></DT>
|
|
|
114 <DD>4.0</DD>
|
|
|
115 <DT><B>Author:</B></DT>
|
|
|
116 <DD><a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a></DD>
|
|
|
117 </DL>
|
|
|
118 <HR>
|
|
|
119
|
|
|
120 <P>
|
|
|
121
|
|
|
122 <!-- ========== METHOD SUMMARY =========== -->
|
|
|
123
|
|
|
124 <A NAME="method_summary"><!-- --></A>
|
|
|
125 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
126 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
127 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
128 <B>Method Summary</B></FONT></TH>
|
|
|
129 </TR>
|
|
|
130 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
131 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
132 <CODE> java.lang.Object</CODE></FONT></TD>
|
|
|
133 <TD><CODE><B><A HREF="../../../../org/apache/http/client/UserTokenHandler.html#getUserToken(org.apache.http.protocol.HttpContext)">getUserToken</A></B>(org.apache.http.protocol.HttpContext context)</CODE>
|
|
|
134
|
|
|
135 <BR>
|
|
|
136 The token object returned by this method is expected to uniquely
|
|
|
137 identify the current user if the context is user specific or to be
|
|
|
138 <code>null</code> if it is not.</TD>
|
|
|
139 </TR>
|
|
|
140 </TABLE>
|
|
|
141
|
|
|
142 <P>
|
|
|
143
|
|
|
144 <!-- ============ METHOD DETAIL ========== -->
|
|
|
145
|
|
|
146 <A NAME="method_detail"><!-- --></A>
|
|
|
147 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
148 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
149 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
|
150 <B>Method Detail</B></FONT></TH>
|
|
|
151 </TR>
|
|
|
152 </TABLE>
|
|
|
153
|
|
|
154 <A NAME="getUserToken(org.apache.http.protocol.HttpContext)"><!-- --></A><H3>
|
|
|
155 getUserToken</H3>
|
|
|
156 <PRE>
|
|
|
157 java.lang.Object <B>getUserToken</B>(org.apache.http.protocol.HttpContext context)</PRE>
|
|
|
158 <DL>
|
|
|
159 <DD>The token object returned by this method is expected to uniquely
|
|
|
160 identify the current user if the context is user specific or to be
|
|
|
161 <code>null</code> if it is not.
|
|
|
162 <P>
|
|
|
163 <DD><DL>
|
|
|
164 <DT><B>Parameters:</B><DD><CODE>context</CODE> - the execution context
|
|
|
165 <DT><B>Returns:</B><DD>user token that uniquely identifies the user or
|
|
|
166 <code>null</null> if the context is not user specific.</DL>
|
|
|
167 </DD>
|
|
|
168 </DL>
|
|
|
169 <!-- ========= END OF CLASS DATA ========= -->
|
|
|
170 <HR>
|
|
|
171
|
|
|
172
|
|
|
173 <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
|
174 <A NAME="navbar_bottom"><!-- --></A>
|
|
|
175 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
|
176 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
177 <TR>
|
|
|
178 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
179 <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
|
180 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
181 <TR ALIGN="center" VALIGN="top">
|
|
|
182 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
|
183 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
184 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
185 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/UserTokenHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
186 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
187 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
188 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
189 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
190 </TR>
|
|
|
191 </TABLE>
|
|
|
192 </TD>
|
|
|
193 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
194 </EM>
|
|
|
195 </TD>
|
|
|
196 </TR>
|
|
|
197
|
|
|
198 <TR>
|
|
|
199 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
200 <A HREF="../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client"><B>PREV CLASS</B></A>
|
|
|
201 NEXT CLASS</FONT></TD>
|
|
|
202 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
203 <A HREF="../../../../index.html?org/apache/http/client/UserTokenHandler.html" target="_top"><B>FRAMES</B></A>
|
|
|
204 <A HREF="UserTokenHandler.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
205 <SCRIPT type="text/javascript">
|
|
|
206 <!--
|
|
|
207 if(window==top) {
|
|
|
208 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
209 }
|
|
|
210 //-->
|
|
|
211 </SCRIPT>
|
|
|
212 <NOSCRIPT>
|
|
|
213 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
214 </NOSCRIPT>
|
|
|
215
|
|
|
216
|
|
|
217 </FONT></TD>
|
|
|
218 </TR>
|
|
|
219 <TR>
|
|
|
220 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
221 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
222 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
223 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
|
224 </TR>
|
|
|
225 </TABLE>
|
|
|
226 <A NAME="skip-navbar_bottom"></A>
|
|
|
227 <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
228
|
|
|
229 <HR>
|
|
|
230 Copyright © 1999-2008 <a href="http://www.apache.org/">Apache Software Foundation</a>. All Rights Reserved.
|
|
|
231 </BODY>
|
|
|
232 </HTML>
|
