|
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:50 GMT+01:00 2008 -->
|
|
|
6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
|
7 <TITLE>
|
|
|
8 BasicUserPrincipal (HttpClient 4.0-beta1 API)
|
|
|
9 </TITLE>
|
|
|
10
|
|
|
11 <META NAME="keywords" CONTENT="org.apache.http.auth.BasicUserPrincipal class">
|
|
|
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="BasicUserPrincipal (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/BasicUserPrincipal.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/auth/AuthState.html" title="class in org.apache.http.auth"><B>PREV CLASS</B></A>
|
|
|
57 <A HREF="../../../../org/apache/http/auth/Credentials.html" title="interface in org.apache.http.auth"><B>NEXT CLASS</B></A></FONT></TD>
|
|
|
58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
59 <A HREF="../../../../index.html?org/apache/http/auth/BasicUserPrincipal.html" target="_top"><B>FRAMES</B></A>
|
|
|
60 <A HREF="BasicUserPrincipal.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
79 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.auth</FONT>
|
|
|
90 <BR>
|
|
|
91 Class BasicUserPrincipal</H2>
|
|
|
92 <PRE>
|
|
|
93 java.lang.Object
|
|
|
94 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.http.auth.BasicUserPrincipal</B>
|
|
|
95 </PRE>
|
|
|
96 <DL>
|
|
|
97 <DT><B>All Implemented Interfaces:</B> <DD>java.security.Principal</DD>
|
|
|
98 </DL>
|
|
|
99 <HR>
|
|
|
100 <DL>
|
|
|
101 <DT><PRE>public final class <B>BasicUserPrincipal</B><DT>extends java.lang.Object<DT>implements java.security.Principal</DL>
|
|
|
102 </PRE>
|
|
|
103
|
|
|
104 <P>
|
|
|
105 Basic user principal used for HTTP authentication
|
|
|
106 <P>
|
|
|
107
|
|
|
108 <P>
|
|
|
109 <DL>
|
|
|
110 <DT><B>Since:</B></DT>
|
|
|
111 <DD>4.0</DD>
|
|
|
112 <DT><B>Author:</B></DT>
|
|
|
113 <DD><a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a></DD>
|
|
|
114 </DL>
|
|
|
115 <HR>
|
|
|
116
|
|
|
117 <P>
|
|
|
118
|
|
|
119 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
120
|
|
|
121 <A NAME="constructor_summary"><!-- --></A>
|
|
|
122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
124 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
125 <B>Constructor Summary</B></FONT></TH>
|
|
|
126 </TR>
|
|
|
127 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
128 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/BasicUserPrincipal.html#BasicUserPrincipal(java.lang.String)">BasicUserPrincipal</A></B>(java.lang.String username)</CODE>
|
|
|
129
|
|
|
130 <BR>
|
|
|
131 </TD>
|
|
|
132 </TR>
|
|
|
133 </TABLE>
|
|
|
134
|
|
|
135 <!-- ========== METHOD SUMMARY =========== -->
|
|
|
136
|
|
|
137 <A NAME="method_summary"><!-- --></A>
|
|
|
138 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
139 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
140 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
141 <B>Method Summary</B></FONT></TH>
|
|
|
142 </TR>
|
|
|
143 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
145 <CODE> boolean</CODE></FONT></TD>
|
|
|
146 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/BasicUserPrincipal.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object o)</CODE>
|
|
|
147
|
|
|
148 <BR>
|
|
|
149 </TD>
|
|
|
150 </TR>
|
|
|
151 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
153 <CODE> java.lang.String</CODE></FONT></TD>
|
|
|
154 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/BasicUserPrincipal.html#getName()">getName</A></B>()</CODE>
|
|
|
155
|
|
|
156 <BR>
|
|
|
157 </TD>
|
|
|
158 </TR>
|
|
|
159 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
161 <CODE> int</CODE></FONT></TD>
|
|
|
162 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/BasicUserPrincipal.html#hashCode()">hashCode</A></B>()</CODE>
|
|
|
163
|
|
|
164 <BR>
|
|
|
165 </TD>
|
|
|
166 </TR>
|
|
|
167 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
169 <CODE> java.lang.String</CODE></FONT></TD>
|
|
|
170 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/BasicUserPrincipal.html#toString()">toString</A></B>()</CODE>
|
|
|
171
|
|
|
172 <BR>
|
|
|
173 </TD>
|
|
|
174 </TR>
|
|
|
175 </TABLE>
|
|
|
176 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
|
177 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
178 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
|
179 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
|
|
|
180 </TR>
|
|
|
181 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
182 <TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
|
|
|
183 </TR>
|
|
|
184 </TABLE>
|
|
|
185
|
|
|
186 <P>
|
|
|
187
|
|
|
188 <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
189
|
|
|
190 <A NAME="constructor_detail"><!-- --></A>
|
|
|
191 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
192 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
193 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
|
194 <B>Constructor Detail</B></FONT></TH>
|
|
|
195 </TR>
|
|
|
196 </TABLE>
|
|
|
197
|
|
|
198 <A NAME="BasicUserPrincipal(java.lang.String)"><!-- --></A><H3>
|
|
|
199 BasicUserPrincipal</H3>
|
|
|
200 <PRE>
|
|
|
201 public <B>BasicUserPrincipal</B>(java.lang.String username)</PRE>
|
|
|
202 <DL>
|
|
|
203 </DL>
|
|
|
204
|
|
|
205 <!-- ============ METHOD DETAIL ========== -->
|
|
|
206
|
|
|
207 <A NAME="method_detail"><!-- --></A>
|
|
|
208 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
209 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
210 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
|
211 <B>Method Detail</B></FONT></TH>
|
|
|
212 </TR>
|
|
|
213 </TABLE>
|
|
|
214
|
|
|
215 <A NAME="getName()"><!-- --></A><H3>
|
|
|
216 getName</H3>
|
|
|
217 <PRE>
|
|
|
218 public java.lang.String <B>getName</B>()</PRE>
|
|
|
219 <DL>
|
|
|
220 <DD><DL>
|
|
|
221 <DT><B>Specified by:</B><DD><CODE>getName</CODE> in interface <CODE>java.security.Principal</CODE></DL>
|
|
|
222 </DD>
|
|
|
223 <DD><DL>
|
|
|
224 </DL>
|
|
|
225 </DD>
|
|
|
226 </DL>
|
|
|
227 <HR>
|
|
|
228
|
|
|
229 <A NAME="hashCode()"><!-- --></A><H3>
|
|
|
230 hashCode</H3>
|
|
|
231 <PRE>
|
|
|
232 public int <B>hashCode</B>()</PRE>
|
|
|
233 <DL>
|
|
|
234 <DD><DL>
|
|
|
235 <DT><B>Specified by:</B><DD><CODE>hashCode</CODE> in interface <CODE>java.security.Principal</CODE><DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
|
|
236 </DD>
|
|
|
237 <DD><DL>
|
|
|
238 </DL>
|
|
|
239 </DD>
|
|
|
240 </DL>
|
|
|
241 <HR>
|
|
|
242
|
|
|
243 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
|
|
|
244 equals</H3>
|
|
|
245 <PRE>
|
|
|
246 public boolean <B>equals</B>(java.lang.Object o)</PRE>
|
|
|
247 <DL>
|
|
|
248 <DD><DL>
|
|
|
249 <DT><B>Specified by:</B><DD><CODE>equals</CODE> in interface <CODE>java.security.Principal</CODE><DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
|
|
250 </DD>
|
|
|
251 <DD><DL>
|
|
|
252 </DL>
|
|
|
253 </DD>
|
|
|
254 </DL>
|
|
|
255 <HR>
|
|
|
256
|
|
|
257 <A NAME="toString()"><!-- --></A><H3>
|
|
|
258 toString</H3>
|
|
|
259 <PRE>
|
|
|
260 public java.lang.String <B>toString</B>()</PRE>
|
|
|
261 <DL>
|
|
|
262 <DD><DL>
|
|
|
263 <DT><B>Specified by:</B><DD><CODE>toString</CODE> in interface <CODE>java.security.Principal</CODE><DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
|
|
264 </DD>
|
|
|
265 <DD><DL>
|
|
|
266 </DL>
|
|
|
267 </DD>
|
|
|
268 </DL>
|
|
|
269 <!-- ========= END OF CLASS DATA ========= -->
|
|
|
270 <HR>
|
|
|
271
|
|
|
272
|
|
|
273 <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
|
274 <A NAME="navbar_bottom"><!-- --></A>
|
|
|
275 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
|
276 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
277 <TR>
|
|
|
278 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
279 <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
|
280 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
281 <TR ALIGN="center" VALIGN="top">
|
|
|
282 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
|
283 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
284 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
285 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BasicUserPrincipal.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
286 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
287 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
288 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
289 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
290 </TR>
|
|
|
291 </TABLE>
|
|
|
292 </TD>
|
|
|
293 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
294 </EM>
|
|
|
295 </TD>
|
|
|
296 </TR>
|
|
|
297
|
|
|
298 <TR>
|
|
|
299 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
300 <A HREF="../../../../org/apache/http/auth/AuthState.html" title="class in org.apache.http.auth"><B>PREV CLASS</B></A>
|
|
|
301 <A HREF="../../../../org/apache/http/auth/Credentials.html" title="interface in org.apache.http.auth"><B>NEXT CLASS</B></A></FONT></TD>
|
|
|
302 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
303 <A HREF="../../../../index.html?org/apache/http/auth/BasicUserPrincipal.html" target="_top"><B>FRAMES</B></A>
|
|
|
304 <A HREF="BasicUserPrincipal.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
305 <SCRIPT type="text/javascript">
|
|
|
306 <!--
|
|
|
307 if(window==top) {
|
|
|
308 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
309 }
|
|
|
310 //-->
|
|
|
311 </SCRIPT>
|
|
|
312 <NOSCRIPT>
|
|
|
313 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
314 </NOSCRIPT>
|
|
|
315
|
|
|
316
|
|
|
317 </FONT></TD>
|
|
|
318 </TR>
|
|
|
319 <TR>
|
|
|
320 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
321 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
322 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
323 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
|
324 </TR>
|
|
|
325 </TABLE>
|
|
|
326 <A NAME="skip-navbar_bottom"></A>
|
|
|
327 <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
328
|
|
|
329 <HR>
|
|
|
330 Copyright © 1999-2008 <a href="http://www.apache.org/">Apache Software Foundation</a>. All Rights Reserved.
|
|
|
331 </BODY>
|
|
|
332 </HTML>
|
