~ubuntu-branches/ubuntu/lucid/commons-httpclient/lucid

« back to all changes in this revision

Viewing changes to docs/apidocs/org/apache/commons/httpclient/Authenticator.html

  • Committer: Bazaar Package Importer
  • Author(s): Barry Hawkins
  • Date: 2005-11-25 13:12:23 UTC
  • Revision ID: james.westby@ubuntu.com-20051125131223-2g7eyo21pqgrohpo
Tags: upstream-2.0.2
ImportĀ upstreamĀ versionĀ 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
 
2
<!--NewPage-->
 
3
<HTML>
 
4
<HEAD>
 
5
<!-- Generated by javadoc on Sun Oct 10 17:41:04 EDT 2004 -->
 
6
<TITLE>
 
7
HttpClient 2.0.2 API: Class  Authenticator
 
8
</TITLE>
 
9
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
 
10
</HEAD>
 
11
<BODY BGCOLOR="white">
 
12
 
 
13
<!-- ========== START OF NAVBAR ========== -->
 
14
<A NAME="navbar_top"><!-- --></A>
 
15
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
16
<TR>
 
17
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
18
<A NAME="navbar_top_firstrow"><!-- --></A>
 
19
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
20
  <TR ALIGN="center" VALIGN="top">
 
21
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
22
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
23
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
24
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Authenticator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
25
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
26
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
27
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
28
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
29
  </TR>
 
30
</TABLE>
 
31
</TD>
 
32
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
33
</EM>
 
34
</TD>
 
35
</TR>
 
36
 
 
37
<TR>
 
38
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
39
&nbsp;PREV CLASS&nbsp;
 
40
&nbsp;<A HREF="../../../../org/apache/commons/httpclient/AutoCloseInputStream.html"><B>NEXT CLASS</B></A></FONT></TD>
 
41
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
42
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
43
&nbsp;<A HREF="Authenticator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 
44
</TR>
 
45
<TR>
 
46
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
47
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
48
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
49
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
50
</TR>
 
51
</TABLE>
 
52
<!-- =========== END OF NAVBAR =========== -->
 
53
 
 
54
<HR>
 
55
<!-- ======== START OF CLASS DATA ======== -->
 
56
<H2>
 
57
<FONT SIZE="-1">
 
58
org.apache.commons.httpclient</FONT>
 
59
<BR>
 
60
Class  Authenticator</H2>
 
61
<PRE>
 
62
<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">java.lang.Object</A>
 
63
  |
 
64
  +--<B>org.apache.commons.httpclient.Authenticator</B>
 
65
</PRE>
 
66
<HR>
 
67
<B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../org/apache/commons/httpclient/auth/HttpAuthenticator.html"><CODE>HttpAuthenticator</CODE></A></I>
 
68
<P>
 
69
<DL>
 
70
<DT>public class <B>Authenticator</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">Object</A></DL>
 
71
 
 
72
<P>
 
73
Utility methods for HTTP authorization and authentication.  This class
 
74
 provides utility methods for generating responses to HTTP www and proxy
 
75
 authentication challenges.
 
76
 
 
77
 <blockquote>
 
78
 A client SHOULD assume that all paths at or deeper than the depth of the
 
79
 last symbolic element in the path field of the Request-URI also are within
 
80
 the protection space specified by the BasicScheme realm value of the current
 
81
 challenge. A client MAY preemptively send the corresponding Authorization
 
82
 header with requests for resources in that space without receipt of another
 
83
 challenge from the server. Similarly, when a client sends a request to a
 
84
 proxy, it may reuse a userid and password in the Proxy-Authorization header
 
85
 field without receiving another challenge from the proxy server.
 
86
 </blockquote>
 
87
 </p>
 
88
<P>
 
89
<DL>
 
90
<DT><B>Author: </B><DD><a href="mailto:remm@apache.org">Remy Maucherat</a>, Rodney Waldhoff, <a href="mailto:jsdever@apache.org">Jeff Dever</a>, Ortwin Gl?ck, Sean C. Sullivan, <a href="mailto:adrian@ephox.com">Adrian Sutton</a>, <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>, <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a></DD>
 
91
</DL>
 
92
<HR>
 
93
 
 
94
<P>
 
95
<!-- ======== INNER CLASS SUMMARY ======== -->
 
96
 
 
97
 
 
98
<!-- =========== FIELD SUMMARY =========== -->
 
99
 
 
100
<A NAME="field_summary"><!-- --></A>
 
101
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
102
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
103
<TD COLSPAN=2><FONT SIZE="+2">
 
104
<B>Field Summary</B></FONT></TD>
 
105
</TR>
 
106
<TR BGCOLOR="white" CLASS="TableRowColor">
 
107
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
108
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 
109
<TD><CODE><B><A HREF="../../../../org/apache/commons/httpclient/Authenticator.html#PROXY_AUTH">PROXY_AUTH</A></B></CODE>
 
110
 
 
111
<BR>
 
112
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;The proxy authenticate challange header.</TD>
 
113
</TR>
 
114
<TR BGCOLOR="white" CLASS="TableRowColor">
 
115
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
116
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 
117
<TD><CODE><B><A HREF="../../../../org/apache/commons/httpclient/Authenticator.html#PROXY_AUTH_RESP">PROXY_AUTH_RESP</A></B></CODE>
 
118
 
 
119
<BR>
 
120
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;The proxy authenticate response header.</TD>
 
121
</TR>
 
122
<TR BGCOLOR="white" CLASS="TableRowColor">
 
123
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
124
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 
125
<TD><CODE><B><A HREF="../../../../org/apache/commons/httpclient/Authenticator.html#WWW_AUTH">WWW_AUTH</A></B></CODE>
 
126
 
 
127
<BR>
 
128
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;The www authenticate challange header.</TD>
 
129
</TR>
 
130
<TR BGCOLOR="white" CLASS="TableRowColor">
 
131
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
132
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 
133
<TD><CODE><B><A HREF="../../../../org/apache/commons/httpclient/Authenticator.html#WWW_AUTH_RESP">WWW_AUTH_RESP</A></B></CODE>
 
134
 
 
135
<BR>
 
136
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;The www authenticate response header.</TD>
 
137
</TR>
 
138
</TABLE>
 
139
&nbsp;
 
140
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
141
 
 
142
<A NAME="constructor_summary"><!-- --></A>
 
143
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
144
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
145
<TD COLSPAN=2><FONT SIZE="+2">
 
146
<B>Constructor Summary</B></FONT></TD>
 
147
</TR>
 
148
<TR BGCOLOR="white" CLASS="TableRowColor">
 
149
<TD><CODE><B><A HREF="../../../../org/apache/commons/httpclient/Authenticator.html#Authenticator()">Authenticator</A></B>()</CODE>
 
150
 
 
151
<BR>
 
152
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;&nbsp;</TD>
 
153
</TR>
 
154
</TABLE>
 
155
&nbsp;
 
156
<!-- ========== METHOD SUMMARY =========== -->
 
157
 
 
158
<A NAME="method_summary"><!-- --></A>
 
159
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
160
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
161
<TD COLSPAN=2><FONT SIZE="+2">
 
162
<B>Method Summary</B></FONT></TD>
 
163
</TR>
 
164
<TR BGCOLOR="white" CLASS="TableRowColor">
 
165
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
166
<CODE>static&nbsp;boolean</CODE></FONT></TD>
 
167
<TD><CODE><B><A HREF="../../../../org/apache/commons/httpclient/Authenticator.html#authenticate(org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.HttpState)">authenticate</A></B>(<A HREF="../../../../org/apache/commons/httpclient/HttpMethod.html">HttpMethod</A>&nbsp;method,
 
168
             <A HREF="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</A>&nbsp;state)</CODE>
 
169
 
 
170
<BR>
 
171
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../org/apache/commons/httpclient/auth/HttpAuthenticator.html#authenticate(org.apache.commons.httpclient.auth.AuthScheme, org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.HttpConnection, org.apache.commons.httpclient.HttpState)"><CODE>HttpAuthenticator.authenticate(AuthScheme, HttpMethod, HttpConnection, HttpState)</CODE></A></I></TD>
 
172
</TR>
 
173
<TR BGCOLOR="white" CLASS="TableRowColor">
 
174
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
175
<CODE>static&nbsp;boolean</CODE></FONT></TD>
 
176
<TD><CODE><B><A HREF="../../../../org/apache/commons/httpclient/Authenticator.html#authenticateProxy(org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.HttpState)">authenticateProxy</A></B>(<A HREF="../../../../org/apache/commons/httpclient/HttpMethod.html">HttpMethod</A>&nbsp;method,
 
177
                  <A HREF="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</A>&nbsp;state)</CODE>
 
178
 
 
179
<BR>
 
180
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../org/apache/commons/httpclient/auth/HttpAuthenticator.html#authenticateProxy(org.apache.commons.httpclient.auth.AuthScheme, org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.HttpConnection, org.apache.commons.httpclient.HttpState)"><CODE>HttpAuthenticator.authenticateProxy(AuthScheme, HttpMethod, HttpConnection, HttpState)</CODE></A></I></TD>
 
181
</TR>
 
182
</TABLE>
 
183
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 
184
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
185
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
186
<TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">Object</A></B></TD>
 
187
</TR>
 
188
<TR BGCOLOR="white" CLASS="TableRowColor">
 
189
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#<clinit>()"><clinit></A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#clone()">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#finalize()">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#toString()">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
 
190
</TR>
 
191
</TABLE>
 
192
&nbsp;
 
193
<P>
 
194
 
 
195
<!-- ============ FIELD DETAIL =========== -->
 
196
 
 
197
<A NAME="field_detail"><!-- --></A>
 
198
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
199
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
200
<TD COLSPAN=1><FONT SIZE="+2">
 
201
<B>Field Detail</B></FONT></TD>
 
202
</TR>
 
203
</TABLE>
 
204
 
 
205
<A NAME="WWW_AUTH"><!-- --></A><H3>
 
206
WWW_AUTH</H3>
 
207
<PRE>
 
208
public static final <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> <B>WWW_AUTH</B></PRE>
 
209
<DL>
 
210
<DD><B>Deprecated.</B>&nbsp;<DD>The www authenticate challange header.</DL>
 
211
<HR>
 
212
 
 
213
<A NAME="WWW_AUTH_RESP"><!-- --></A><H3>
 
214
WWW_AUTH_RESP</H3>
 
215
<PRE>
 
216
public static final <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> <B>WWW_AUTH_RESP</B></PRE>
 
217
<DL>
 
218
<DD><B>Deprecated.</B>&nbsp;<DD>The www authenticate response header.</DL>
 
219
<HR>
 
220
 
 
221
<A NAME="PROXY_AUTH"><!-- --></A><H3>
 
222
PROXY_AUTH</H3>
 
223
<PRE>
 
224
public static final <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> <B>PROXY_AUTH</B></PRE>
 
225
<DL>
 
226
<DD><B>Deprecated.</B>&nbsp;<DD>The proxy authenticate challange header.</DL>
 
227
<HR>
 
228
 
 
229
<A NAME="PROXY_AUTH_RESP"><!-- --></A><H3>
 
230
PROXY_AUTH_RESP</H3>
 
231
<PRE>
 
232
public static final <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> <B>PROXY_AUTH_RESP</B></PRE>
 
233
<DL>
 
234
<DD><B>Deprecated.</B>&nbsp;<DD>The proxy authenticate response header.</DL>
 
235
 
 
236
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
237
 
 
238
<A NAME="constructor_detail"><!-- --></A>
 
239
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
240
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
241
<TD COLSPAN=1><FONT SIZE="+2">
 
242
<B>Constructor Detail</B></FONT></TD>
 
243
</TR>
 
244
</TABLE>
 
245
 
 
246
<A NAME="Authenticator()"><!-- --></A><H3>
 
247
Authenticator</H3>
 
248
<PRE>
 
249
public <B>Authenticator</B>()</PRE>
 
250
<DL>
 
251
<DD><B>Deprecated.</B>&nbsp;</DL>
 
252
 
 
253
<!-- ============ METHOD DETAIL ========== -->
 
254
 
 
255
<A NAME="method_detail"><!-- --></A>
 
256
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
257
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
258
<TD COLSPAN=1><FONT SIZE="+2">
 
259
<B>Method Detail</B></FONT></TD>
 
260
</TR>
 
261
</TABLE>
 
262
 
 
263
<A NAME="authenticate(org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.HttpState)"><!-- --></A><H3>
 
264
authenticate</H3>
 
265
<PRE>
 
266
public static boolean <B>authenticate</B>(<A HREF="../../../../org/apache/commons/httpclient/HttpMethod.html">HttpMethod</A>&nbsp;method,
 
267
                                   <A HREF="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</A>&nbsp;state)
 
268
                            throws <A HREF="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</A>,
 
269
                                   <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/UnsupportedOperationException.html">UnsupportedOperationException</A></PRE>
 
270
<DL>
 
271
<DD><B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../org/apache/commons/httpclient/auth/HttpAuthenticator.html#authenticate(org.apache.commons.httpclient.auth.AuthScheme, org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.HttpConnection, org.apache.commons.httpclient.HttpState)"><CODE>HttpAuthenticator.authenticate(AuthScheme, HttpMethod, HttpConnection, HttpState)</CODE></A></I>
 
272
<P>
 
273
<DD>Add requisite authentication credentials to the given <i>method</i> in
 
274
 the given <i>state</i> if possible.<DD><DL>
 
275
<DT><B>Parameters:</B><DD><CODE>method</CODE> - the HttpMethod which requires authentication<DD><CODE>state</CODE> - the HttpState object providing Credentials<DT><B>Returns:</B><DD>true if the Authenticate response header was added<DT><B>Throws:</B><DD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</A></CODE> - when a parsing or other error occurs<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/UnsupportedOperationException.html">UnsupportedOperationException</A></CODE> - when the challenge type is not
 
276
         supported<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setCredentials(java.lang.String, org.apache.commons.httpclient.Credentials)"><CODE>HttpState.setCredentials(String,Credentials)</CODE></A></DL>
 
277
</DD>
 
278
</DL>
 
279
<HR>
 
280
 
 
281
<A NAME="authenticateProxy(org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.HttpState)"><!-- --></A><H3>
 
282
authenticateProxy</H3>
 
283
<PRE>
 
284
public static boolean <B>authenticateProxy</B>(<A HREF="../../../../org/apache/commons/httpclient/HttpMethod.html">HttpMethod</A>&nbsp;method,
 
285
                                        <A HREF="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</A>&nbsp;state)
 
286
                                 throws <A HREF="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</A>,
 
287
                                        <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/UnsupportedOperationException.html">UnsupportedOperationException</A></PRE>
 
288
<DL>
 
289
<DD><B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../org/apache/commons/httpclient/auth/HttpAuthenticator.html#authenticateProxy(org.apache.commons.httpclient.auth.AuthScheme, org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.HttpConnection, org.apache.commons.httpclient.HttpState)"><CODE>HttpAuthenticator.authenticateProxy(AuthScheme, HttpMethod, HttpConnection, HttpState)</CODE></A></I>
 
290
<P>
 
291
<DD>Add requisite proxy authentication credentials to the given
 
292
 <i>method</i> in the given <i>state</i> if possible.<DD><DL>
 
293
<DT><B>Parameters:</B><DD><CODE>method</CODE> - the HttpMethod which requires authentication<DD><CODE>state</CODE> - the HttpState object providing Credentials<DT><B>Returns:</B><DD>true if the Authenticate response header was added<DT><B>Throws:</B><DD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</A></CODE> - when a parsing or other error occurs<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/UnsupportedOperationException.html">UnsupportedOperationException</A></CODE> - when the given challenge type is
 
294
         not supported<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setProxyCredentials(java.lang.String, org.apache.commons.httpclient.Credentials)"><CODE>HttpState.setProxyCredentials(String,Credentials)</CODE></A></DL>
 
295
</DD>
 
296
</DL>
 
297
<!-- ========= END OF CLASS DATA ========= -->
 
298
<HR>
 
299
 
 
300
<!-- ========== START OF NAVBAR ========== -->
 
301
<A NAME="navbar_bottom"><!-- --></A>
 
302
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
303
<TR>
 
304
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
305
<A NAME="navbar_bottom_firstrow"><!-- --></A>
 
306
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
307
  <TR ALIGN="center" VALIGN="top">
 
308
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
309
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
310
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
311
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Authenticator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
312
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
313
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
314
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
315
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
316
  </TR>
 
317
</TABLE>
 
318
</TD>
 
319
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
320
</EM>
 
321
</TD>
 
322
</TR>
 
323
 
 
324
<TR>
 
325
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
326
&nbsp;PREV CLASS&nbsp;
 
327
&nbsp;<A HREF="../../../../org/apache/commons/httpclient/AutoCloseInputStream.html"><B>NEXT CLASS</B></A></FONT></TD>
 
328
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
329
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
330
&nbsp;<A HREF="Authenticator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 
331
</TR>
 
332
<TR>
 
333
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
334
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
335
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
336
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
337
</TR>
 
338
</TABLE>
 
339
<!-- =========== END OF NAVBAR =========== -->
 
340
 
 
341
<HR>
 
342
Copyright &copy; 2001-2004 Apache Software Foundation. All Rights Reserved.
 
343
</BODY>
 
344
</HTML>