|
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 AuthScope (HttpClient 4.0-beta1 API)
|
|
|
9 </TITLE>
|
|
|
10
|
|
|
11 <META NAME="keywords" CONTENT="org.apache.http.auth.AuthScope 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="AuthScope (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/AuthScope.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/AuthSchemeRegistry.html" title="class in org.apache.http.auth"><B>PREV CLASS</B></A>
|
|
|
57 <A HREF="../../../../org/apache/http/auth/AuthState.html" title="class 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/AuthScope.html" target="_top"><B>FRAMES</B></A>
|
|
|
60 <A HREF="AuthScope.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 | <A HREF="#field_summary">FIELD</A> | <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: <A HREF="#field_detail">FIELD</A> | <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 AuthScope</H2>
|
|
|
92 <PRE>
|
|
|
93 java.lang.Object
|
|
|
94 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.http.auth.AuthScope</B>
|
|
|
95 </PRE>
|
|
|
96 <HR>
|
|
|
97 <DL>
|
|
|
98 <DT><PRE>public class <B>AuthScope</B><DT>extends java.lang.Object</DL>
|
|
|
99 </PRE>
|
|
|
100
|
|
|
101 <P>
|
|
|
102 The class represents an authentication scope consisting of a host name,
|
|
|
103 a port number, a realm name and an authentication scheme name which
|
|
|
104 <A HREF="../../../../org/apache/http/auth/Credentials.html" title="interface in org.apache.http.auth"><CODE>Credentials</CODE></A> apply to.
|
|
|
105 <P>
|
|
|
106
|
|
|
107 <P>
|
|
|
108 <DL>
|
|
|
109 <DT><B>Since:</B></DT>
|
|
|
110 <DD>4.0</DD>
|
|
|
111 <DT><B>Author:</B></DT>
|
|
|
112 <DD><a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>, <a href="mailto:adrian@intencha.com">Adrian Sutton</a></DD>
|
|
|
113 </DL>
|
|
|
114 <HR>
|
|
|
115
|
|
|
116 <P>
|
|
|
117 <!-- =========== FIELD SUMMARY =========== -->
|
|
|
118
|
|
|
119 <A NAME="field_summary"><!-- --></A>
|
|
|
120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
121 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
122 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
123 <B>Field Summary</B></FONT></TH>
|
|
|
124 </TR>
|
|
|
125 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
126 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
127 <CODE>static <A HREF="../../../../org/apache/http/auth/AuthScope.html" title="class in org.apache.http.auth">AuthScope</A></CODE></FONT></TD>
|
|
|
128 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#ANY">ANY</A></B></CODE>
|
|
|
129
|
|
|
130 <BR>
|
|
|
131 Default scope matching any host, port, realm and authentication scheme.</TD>
|
|
|
132 </TR>
|
|
|
133 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
134 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
135 <CODE>static java.lang.String</CODE></FONT></TD>
|
|
|
136 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#ANY_HOST">ANY_HOST</A></B></CODE>
|
|
|
137
|
|
|
138 <BR>
|
|
|
139 The <tt>null</tt> value represents any host.</TD>
|
|
|
140 </TR>
|
|
|
141 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
143 <CODE>static int</CODE></FONT></TD>
|
|
|
144 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#ANY_PORT">ANY_PORT</A></B></CODE>
|
|
|
145
|
|
|
146 <BR>
|
|
|
147 The <tt>-1</tt> value represents any port.</TD>
|
|
|
148 </TR>
|
|
|
149 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
151 <CODE>static java.lang.String</CODE></FONT></TD>
|
|
|
152 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#ANY_REALM">ANY_REALM</A></B></CODE>
|
|
|
153
|
|
|
154 <BR>
|
|
|
155 The <tt>null</tt> value represents any realm.</TD>
|
|
|
156 </TR>
|
|
|
157 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
159 <CODE>static java.lang.String</CODE></FONT></TD>
|
|
|
160 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#ANY_SCHEME">ANY_SCHEME</A></B></CODE>
|
|
|
161
|
|
|
162 <BR>
|
|
|
163 The <tt>null</tt> value represents any authentication scheme.</TD>
|
|
|
164 </TR>
|
|
|
165 </TABLE>
|
|
|
166
|
|
|
167 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
168
|
|
|
169 <A NAME="constructor_summary"><!-- --></A>
|
|
|
170 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
171 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
172 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
173 <B>Constructor Summary</B></FONT></TH>
|
|
|
174 </TR>
|
|
|
175 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
176 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#AuthScope(org.apache.http.auth.AuthScope)">AuthScope</A></B>(<A HREF="../../../../org/apache/http/auth/AuthScope.html" title="class in org.apache.http.auth">AuthScope</A> authscope)</CODE>
|
|
|
177
|
|
|
178 <BR>
|
|
|
179 Creates a copy of the given credentials scope.</TD>
|
|
|
180 </TR>
|
|
|
181 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
182 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#AuthScope(java.lang.String, int)">AuthScope</A></B>(java.lang.String host,
|
|
|
183 int port)</CODE>
|
|
|
184
|
|
|
185 <BR>
|
|
|
186 Creates a new credentials scope for the given
|
|
|
187 <tt>host</tt>, <tt>port</tt>, any realm name, and any
|
|
|
188 authentication scheme.</TD>
|
|
|
189 </TR>
|
|
|
190 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
191 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#AuthScope(java.lang.String, int, java.lang.String)">AuthScope</A></B>(java.lang.String host,
|
|
|
192 int port,
|
|
|
193 java.lang.String realm)</CODE>
|
|
|
194
|
|
|
195 <BR>
|
|
|
196 Creates a new credentials scope for the given
|
|
|
197 <tt>host</tt>, <tt>port</tt>, <tt>realm</tt>, and any
|
|
|
198 authentication scheme.</TD>
|
|
|
199 </TR>
|
|
|
200 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
201 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#AuthScope(java.lang.String, int, java.lang.String, java.lang.String)">AuthScope</A></B>(java.lang.String host,
|
|
|
202 int port,
|
|
|
203 java.lang.String realm,
|
|
|
204 java.lang.String scheme)</CODE>
|
|
|
205
|
|
|
206 <BR>
|
|
|
207 Creates a new credentials scope for the given
|
|
|
208 <tt>host</tt>, <tt>port</tt>, <tt>realm</tt>, and
|
|
|
209 <tt>authentication scheme</tt>.</TD>
|
|
|
210 </TR>
|
|
|
211 </TABLE>
|
|
|
212
|
|
|
213 <!-- ========== METHOD SUMMARY =========== -->
|
|
|
214
|
|
|
215 <A NAME="method_summary"><!-- --></A>
|
|
|
216 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
217 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
218 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
219 <B>Method Summary</B></FONT></TH>
|
|
|
220 </TR>
|
|
|
221 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
223 <CODE> boolean</CODE></FONT></TD>
|
|
|
224 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object o)</CODE>
|
|
|
225
|
|
|
226 <BR>
|
|
|
227 </TD>
|
|
|
228 </TR>
|
|
|
229 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
231 <CODE> java.lang.String</CODE></FONT></TD>
|
|
|
232 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#getHost()">getHost</A></B>()</CODE>
|
|
|
233
|
|
|
234 <BR>
|
|
|
235 </TD>
|
|
|
236 </TR>
|
|
|
237 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
238 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
239 <CODE> int</CODE></FONT></TD>
|
|
|
240 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#getPort()">getPort</A></B>()</CODE>
|
|
|
241
|
|
|
242 <BR>
|
|
|
243 </TD>
|
|
|
244 </TR>
|
|
|
245 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
246 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
247 <CODE> java.lang.String</CODE></FONT></TD>
|
|
|
248 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#getRealm()">getRealm</A></B>()</CODE>
|
|
|
249
|
|
|
250 <BR>
|
|
|
251 </TD>
|
|
|
252 </TR>
|
|
|
253 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
254 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
255 <CODE> java.lang.String</CODE></FONT></TD>
|
|
|
256 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#getScheme()">getScheme</A></B>()</CODE>
|
|
|
257
|
|
|
258 <BR>
|
|
|
259 </TD>
|
|
|
260 </TR>
|
|
|
261 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
262 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
263 <CODE> int</CODE></FONT></TD>
|
|
|
264 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#hashCode()">hashCode</A></B>()</CODE>
|
|
|
265
|
|
|
266 <BR>
|
|
|
267 </TD>
|
|
|
268 </TR>
|
|
|
269 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
270 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
271 <CODE> int</CODE></FONT></TD>
|
|
|
272 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#match(org.apache.http.auth.AuthScope)">match</A></B>(<A HREF="../../../../org/apache/http/auth/AuthScope.html" title="class in org.apache.http.auth">AuthScope</A> that)</CODE>
|
|
|
273
|
|
|
274 <BR>
|
|
|
275 Tests if the authentication scopes match.</TD>
|
|
|
276 </TR>
|
|
|
277 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
278 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
279 <CODE> java.lang.String</CODE></FONT></TD>
|
|
|
280 <TD><CODE><B><A HREF="../../../../org/apache/http/auth/AuthScope.html#toString()">toString</A></B>()</CODE>
|
|
|
281
|
|
|
282 <BR>
|
|
|
283 </TD>
|
|
|
284 </TR>
|
|
|
285 </TABLE>
|
|
|
286 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
|
287 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
288 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
|
289 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
|
|
|
290 </TR>
|
|
|
291 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
292 <TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
|
|
|
293 </TR>
|
|
|
294 </TABLE>
|
|
|
295
|
|
|
296 <P>
|
|
|
297
|
|
|
298 <!-- ============ FIELD DETAIL =========== -->
|
|
|
299
|
|
|
300 <A NAME="field_detail"><!-- --></A>
|
|
|
301 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
302 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
303 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
|
304 <B>Field Detail</B></FONT></TH>
|
|
|
305 </TR>
|
|
|
306 </TABLE>
|
|
|
307
|
|
|
308 <A NAME="ANY_HOST"><!-- --></A><H3>
|
|
|
309 ANY_HOST</H3>
|
|
|
310 <PRE>
|
|
|
311 public static final java.lang.String <B>ANY_HOST</B></PRE>
|
|
|
312 <DL>
|
|
|
313 <DD>The <tt>null</tt> value represents any host. In the future versions of
|
|
|
314 HttpClient the use of this parameter will be discontinued.
|
|
|
315 <P>
|
|
|
316 <DL>
|
|
|
317 </DL>
|
|
|
318 </DL>
|
|
|
319 <HR>
|
|
|
320
|
|
|
321 <A NAME="ANY_PORT"><!-- --></A><H3>
|
|
|
322 ANY_PORT</H3>
|
|
|
323 <PRE>
|
|
|
324 public static final int <B>ANY_PORT</B></PRE>
|
|
|
325 <DL>
|
|
|
326 <DD>The <tt>-1</tt> value represents any port.
|
|
|
327 <P>
|
|
|
328 <DL>
|
|
|
329 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.http.auth.AuthScope.ANY_PORT">Constant Field Values</A></DL>
|
|
|
330 </DL>
|
|
|
331 <HR>
|
|
|
332
|
|
|
333 <A NAME="ANY_REALM"><!-- --></A><H3>
|
|
|
334 ANY_REALM</H3>
|
|
|
335 <PRE>
|
|
|
336 public static final java.lang.String <B>ANY_REALM</B></PRE>
|
|
|
337 <DL>
|
|
|
338 <DD>The <tt>null</tt> value represents any realm.
|
|
|
339 <P>
|
|
|
340 <DL>
|
|
|
341 </DL>
|
|
|
342 </DL>
|
|
|
343 <HR>
|
|
|
344
|
|
|
345 <A NAME="ANY_SCHEME"><!-- --></A><H3>
|
|
|
346 ANY_SCHEME</H3>
|
|
|
347 <PRE>
|
|
|
348 public static final java.lang.String <B>ANY_SCHEME</B></PRE>
|
|
|
349 <DL>
|
|
|
350 <DD>The <tt>null</tt> value represents any authentication scheme.
|
|
|
351 <P>
|
|
|
352 <DL>
|
|
|
353 </DL>
|
|
|
354 </DL>
|
|
|
355 <HR>
|
|
|
356
|
|
|
357 <A NAME="ANY"><!-- --></A><H3>
|
|
|
358 ANY</H3>
|
|
|
359 <PRE>
|
|
|
360 public static final <A HREF="../../../../org/apache/http/auth/AuthScope.html" title="class in org.apache.http.auth">AuthScope</A> <B>ANY</B></PRE>
|
|
|
361 <DL>
|
|
|
362 <DD>Default scope matching any host, port, realm and authentication scheme.
|
|
|
363 In the future versions of HttpClient the use of this parameter will be
|
|
|
364 discontinued.
|
|
|
365 <P>
|
|
|
366 <DL>
|
|
|
367 </DL>
|
|
|
368 </DL>
|
|
|
369
|
|
|
370 <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
371
|
|
|
372 <A NAME="constructor_detail"><!-- --></A>
|
|
|
373 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
374 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
375 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
|
376 <B>Constructor Detail</B></FONT></TH>
|
|
|
377 </TR>
|
|
|
378 </TABLE>
|
|
|
379
|
|
|
380 <A NAME="AuthScope(java.lang.String, int, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
|
381 AuthScope</H3>
|
|
|
382 <PRE>
|
|
|
383 public <B>AuthScope</B>(java.lang.String host,
|
|
|
384 int port,
|
|
|
385 java.lang.String realm,
|
|
|
386 java.lang.String scheme)</PRE>
|
|
|
387 <DL>
|
|
|
388 <DD>Creates a new credentials scope for the given
|
|
|
389 <tt>host</tt>, <tt>port</tt>, <tt>realm</tt>, and
|
|
|
390 <tt>authentication scheme</tt>.
|
|
|
391 <P>
|
|
|
392 <DL>
|
|
|
393 <DT><B>Parameters:</B><DD><CODE>host</CODE> - the host the credentials apply to. May be set
|
|
|
394 to <tt>null</tt> if credenticals are applicable to
|
|
|
395 any host.<DD><CODE>port</CODE> - the port the credentials apply to. May be set
|
|
|
396 to negative value if credenticals are applicable to
|
|
|
397 any port.<DD><CODE>realm</CODE> - the realm the credentials apply to. May be set
|
|
|
398 to <tt>null</tt> if credenticals are applicable to
|
|
|
399 any realm.<DD><CODE>scheme</CODE> - the authentication scheme the credentials apply to.
|
|
|
400 May be set to <tt>null</tt> if credenticals are applicable to
|
|
|
401 any authentication scheme.</DL>
|
|
|
402 </DL>
|
|
|
403 <HR>
|
|
|
404
|
|
|
405 <A NAME="AuthScope(java.lang.String, int, java.lang.String)"><!-- --></A><H3>
|
|
|
406 AuthScope</H3>
|
|
|
407 <PRE>
|
|
|
408 public <B>AuthScope</B>(java.lang.String host,
|
|
|
409 int port,
|
|
|
410 java.lang.String realm)</PRE>
|
|
|
411 <DL>
|
|
|
412 <DD>Creates a new credentials scope for the given
|
|
|
413 <tt>host</tt>, <tt>port</tt>, <tt>realm</tt>, and any
|
|
|
414 authentication scheme.
|
|
|
415 <P>
|
|
|
416 <DL>
|
|
|
417 <DT><B>Parameters:</B><DD><CODE>host</CODE> - the host the credentials apply to. May be set
|
|
|
418 to <tt>null</tt> if credenticals are applicable to
|
|
|
419 any host.<DD><CODE>port</CODE> - the port the credentials apply to. May be set
|
|
|
420 to negative value if credenticals are applicable to
|
|
|
421 any port.<DD><CODE>realm</CODE> - the realm the credentials apply to. May be set
|
|
|
422 to <tt>null</tt> if credenticals are applicable to
|
|
|
423 any realm.</DL>
|
|
|
424 </DL>
|
|
|
425 <HR>
|
|
|
426
|
|
|
427 <A NAME="AuthScope(java.lang.String, int)"><!-- --></A><H3>
|
|
|
428 AuthScope</H3>
|
|
|
429 <PRE>
|
|
|
430 public <B>AuthScope</B>(java.lang.String host,
|
|
|
431 int port)</PRE>
|
|
|
432 <DL>
|
|
|
433 <DD>Creates a new credentials scope for the given
|
|
|
434 <tt>host</tt>, <tt>port</tt>, any realm name, and any
|
|
|
435 authentication scheme.
|
|
|
436 <P>
|
|
|
437 <DL>
|
|
|
438 <DT><B>Parameters:</B><DD><CODE>host</CODE> - the host the credentials apply to. May be set
|
|
|
439 to <tt>null</tt> if credenticals are applicable to
|
|
|
440 any host.<DD><CODE>port</CODE> - the port the credentials apply to. May be set
|
|
|
441 to negative value if credenticals are applicable to
|
|
|
442 any port.</DL>
|
|
|
443 </DL>
|
|
|
444 <HR>
|
|
|
445
|
|
|
446 <A NAME="AuthScope(org.apache.http.auth.AuthScope)"><!-- --></A><H3>
|
|
|
447 AuthScope</H3>
|
|
|
448 <PRE>
|
|
|
449 public <B>AuthScope</B>(<A HREF="../../../../org/apache/http/auth/AuthScope.html" title="class in org.apache.http.auth">AuthScope</A> authscope)</PRE>
|
|
|
450 <DL>
|
|
|
451 <DD>Creates a copy of the given credentials scope.
|
|
|
452 <P>
|
|
|
453 </DL>
|
|
|
454
|
|
|
455 <!-- ============ METHOD DETAIL ========== -->
|
|
|
456
|
|
|
457 <A NAME="method_detail"><!-- --></A>
|
|
|
458 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
459 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
460 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
|
461 <B>Method Detail</B></FONT></TH>
|
|
|
462 </TR>
|
|
|
463 </TABLE>
|
|
|
464
|
|
|
465 <A NAME="getHost()"><!-- --></A><H3>
|
|
|
466 getHost</H3>
|
|
|
467 <PRE>
|
|
|
468 public java.lang.String <B>getHost</B>()</PRE>
|
|
|
469 <DL>
|
|
|
470 <DD><DL>
|
|
|
471
|
|
|
472 <DT><B>Returns:</B><DD>the host</DL>
|
|
|
473 </DD>
|
|
|
474 </DL>
|
|
|
475 <HR>
|
|
|
476
|
|
|
477 <A NAME="getPort()"><!-- --></A><H3>
|
|
|
478 getPort</H3>
|
|
|
479 <PRE>
|
|
|
480 public int <B>getPort</B>()</PRE>
|
|
|
481 <DL>
|
|
|
482 <DD><DL>
|
|
|
483
|
|
|
484 <DT><B>Returns:</B><DD>the port</DL>
|
|
|
485 </DD>
|
|
|
486 </DL>
|
|
|
487 <HR>
|
|
|
488
|
|
|
489 <A NAME="getRealm()"><!-- --></A><H3>
|
|
|
490 getRealm</H3>
|
|
|
491 <PRE>
|
|
|
492 public java.lang.String <B>getRealm</B>()</PRE>
|
|
|
493 <DL>
|
|
|
494 <DD><DL>
|
|
|
495
|
|
|
496 <DT><B>Returns:</B><DD>the realm name</DL>
|
|
|
497 </DD>
|
|
|
498 </DL>
|
|
|
499 <HR>
|
|
|
500
|
|
|
501 <A NAME="getScheme()"><!-- --></A><H3>
|
|
|
502 getScheme</H3>
|
|
|
503 <PRE>
|
|
|
504 public java.lang.String <B>getScheme</B>()</PRE>
|
|
|
505 <DL>
|
|
|
506 <DD><DL>
|
|
|
507
|
|
|
508 <DT><B>Returns:</B><DD>the scheme type</DL>
|
|
|
509 </DD>
|
|
|
510 </DL>
|
|
|
511 <HR>
|
|
|
512
|
|
|
513 <A NAME="match(org.apache.http.auth.AuthScope)"><!-- --></A><H3>
|
|
|
514 match</H3>
|
|
|
515 <PRE>
|
|
|
516 public int <B>match</B>(<A HREF="../../../../org/apache/http/auth/AuthScope.html" title="class in org.apache.http.auth">AuthScope</A> that)</PRE>
|
|
|
517 <DL>
|
|
|
518 <DD>Tests if the authentication scopes match.
|
|
|
519 <P>
|
|
|
520 <DD><DL>
|
|
|
521
|
|
|
522 <DT><B>Returns:</B><DD>the match factor. Negative value signifies no match.
|
|
|
523 Non-negative signifies a match. The greater the returned value
|
|
|
524 the closer the match.</DL>
|
|
|
525 </DD>
|
|
|
526 </DL>
|
|
|
527 <HR>
|
|
|
528
|
|
|
529 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
|
|
|
530 equals</H3>
|
|
|
531 <PRE>
|
|
|
532 public boolean <B>equals</B>(java.lang.Object o)</PRE>
|
|
|
533 <DL>
|
|
|
534 <DD><DL>
|
|
|
535 <DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
|
|
536 </DD>
|
|
|
537 <DD><DL>
|
|
|
538 <DT><B>See Also:</B><DD><CODE>Object.equals(Object)</CODE></DL>
|
|
|
539 </DD>
|
|
|
540 </DL>
|
|
|
541 <HR>
|
|
|
542
|
|
|
543 <A NAME="toString()"><!-- --></A><H3>
|
|
|
544 toString</H3>
|
|
|
545 <PRE>
|
|
|
546 public java.lang.String <B>toString</B>()</PRE>
|
|
|
547 <DL>
|
|
|
548 <DD><DL>
|
|
|
549 <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
|
|
550 </DD>
|
|
|
551 <DD><DL>
|
|
|
552 <DT><B>See Also:</B><DD><CODE>Object.toString()</CODE></DL>
|
|
|
553 </DD>
|
|
|
554 </DL>
|
|
|
555 <HR>
|
|
|
556
|
|
|
557 <A NAME="hashCode()"><!-- --></A><H3>
|
|
|
558 hashCode</H3>
|
|
|
559 <PRE>
|
|
|
560 public int <B>hashCode</B>()</PRE>
|
|
|
561 <DL>
|
|
|
562 <DD><DL>
|
|
|
563 <DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
|
|
564 </DD>
|
|
|
565 <DD><DL>
|
|
|
566 <DT><B>See Also:</B><DD><CODE>Object.hashCode()</CODE></DL>
|
|
|
567 </DD>
|
|
|
568 </DL>
|
|
|
569 <!-- ========= END OF CLASS DATA ========= -->
|
|
|
570 <HR>
|
|
|
571
|
|
|
572
|
|
|
573 <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
|
574 <A NAME="navbar_bottom"><!-- --></A>
|
|
|
575 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
|
576 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
577 <TR>
|
|
|
578 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
579 <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
|
580 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
581 <TR ALIGN="center" VALIGN="top">
|
|
|
582 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
|
583 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
584 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
585 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AuthScope.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
586 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
587 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
588 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
589 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
590 </TR>
|
|
|
591 </TABLE>
|
|
|
592 </TD>
|
|
|
593 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
594 </EM>
|
|
|
595 </TD>
|
|
|
596 </TR>
|
|
|
597
|
|
|
598 <TR>
|
|
|
599 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
600 <A HREF="../../../../org/apache/http/auth/AuthSchemeRegistry.html" title="class in org.apache.http.auth"><B>PREV CLASS</B></A>
|
|
|
601 <A HREF="../../../../org/apache/http/auth/AuthState.html" title="class in org.apache.http.auth"><B>NEXT CLASS</B></A></FONT></TD>
|
|
|
602 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
603 <A HREF="../../../../index.html?org/apache/http/auth/AuthScope.html" target="_top"><B>FRAMES</B></A>
|
|
|
604 <A HREF="AuthScope.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
605 <SCRIPT type="text/javascript">
|
|
|
606 <!--
|
|
|
607 if(window==top) {
|
|
|
608 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
609 }
|
|
|
610 //-->
|
|
|
611 </SCRIPT>
|
|
|
612 <NOSCRIPT>
|
|
|
613 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
614 </NOSCRIPT>
|
|
|
615
|
|
|
616
|
|
|
617 </FONT></TD>
|
|
|
618 </TR>
|
|
|
619 <TR>
|
|
|
620 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
621 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
622 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
623 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
|
624 </TR>
|
|
|
625 </TABLE>
|
|
|
626 <A NAME="skip-navbar_bottom"></A>
|
|
|
627 <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
628
|
|
|
629 <HR>
|
|
|
630 Copyright © 1999-2008 <a href="http://www.apache.org/">Apache Software Foundation</a>. All Rights Reserved.
|
|
|
631 </BODY>
|
|
|
632 </HTML>
|
