← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/apidocs/org/apache/commons/httpclient/auth/AuthChallengeParser.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:
docs/apidocs/org/apache/commons/httpclient/auth/AuthChallengeParser.html
 
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:05 EDT 2004 -->
 
6
<TITLE>
 
7
HttpClient 2.0.2 API: Class  AuthChallengeParser
 
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/AuthChallengeParser.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/auth/AuthSchemeBase.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="AuthChallengeParser.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;FIELD&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;FIELD&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.auth</FONT>
 
59
<BR>
 
60
Class  AuthChallengeParser</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.auth.AuthChallengeParser</B>
 
65
</PRE>
 
66
<HR>
 
67
<DL>
 
68
<DT>public final class <B>AuthChallengeParser</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">Object</A></DL>
 
69
 
 
70
<P>
 
71
This class provides utility methods for parsing HTTP www and proxy authentication 
 
72
 challenges.
 
73
<P>
 
74
<DL>
 
75
<DT><B>Since: </B><DD>2.0beta1</DD>
 
76
<DT><B>Author: </B><DD><a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a></DD>
 
77
</DL>
 
78
<HR>
 
79
 
 
80
<P>
 
81
<!-- ======== INNER CLASS SUMMARY ======== -->
 
82
 
 
83
 
 
84
<!-- =========== FIELD SUMMARY =========== -->
 
85
 
 
86
 
 
87
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
88
 
 
89
<A NAME="constructor_summary"><!-- --></A>
 
90
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
91
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
92
<TD COLSPAN=2><FONT SIZE="+2">
 
93
<B>Constructor Summary</B></FONT></TD>
 
94
</TR>
 
95
<TR BGCOLOR="white" CLASS="TableRowColor">
 
96
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthChallengeParser.html#AuthChallengeParser()">AuthChallengeParser</A></B>()</CODE>
 
97
 
 
98
<BR>
 
99
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
100
</TR>
 
101
</TABLE>
 
102
&nbsp;
 
103
<!-- ========== METHOD SUMMARY =========== -->
 
104
 
 
105
<A NAME="method_summary"><!-- --></A>
 
106
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
107
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
108
<TD COLSPAN=2><FONT SIZE="+2">
 
109
<B>Method Summary</B></FONT></TD>
 
110
</TR>
 
111
<TR BGCOLOR="white" CLASS="TableRowColor">
 
112
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
113
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/util/Map.html">Map</A></CODE></FONT></TD>
 
114
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthChallengeParser.html#extractParams(java.lang.String)">extractParams</A></B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A>&nbsp;challengeStr)</CODE>
 
115
 
 
116
<BR>
 
117
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extracts a map of challenge parameters from an authentication challenge.</TD>
 
118
</TR>
 
119
<TR BGCOLOR="white" CLASS="TableRowColor">
 
120
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
121
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 
122
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthChallengeParser.html#extractScheme(java.lang.String)">extractScheme</A></B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A>&nbsp;challengeStr)</CODE>
 
123
 
 
124
<BR>
 
125
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extracts authentication scheme from the given authentication 
 
126
 challenge.</TD>
 
127
</TR>
 
128
</TABLE>
 
129
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 
130
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
131
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
132
<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>
 
133
</TR>
 
134
<TR BGCOLOR="white" CLASS="TableRowColor">
 
135
<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>
 
136
</TR>
 
137
</TABLE>
 
138
&nbsp;
 
139
<P>
 
140
 
 
141
<!-- ============ FIELD DETAIL =========== -->
 
142
 
 
143
 
 
144
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
145
 
 
146
<A NAME="constructor_detail"><!-- --></A>
 
147
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
148
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
149
<TD COLSPAN=1><FONT SIZE="+2">
 
150
<B>Constructor Detail</B></FONT></TD>
 
151
</TR>
 
152
</TABLE>
 
153
 
 
154
<A NAME="AuthChallengeParser()"><!-- --></A><H3>
 
155
AuthChallengeParser</H3>
 
156
<PRE>
 
157
public <B>AuthChallengeParser</B>()</PRE>
 
158
<DL>
 
159
</DL>
 
160
 
 
161
<!-- ============ METHOD DETAIL ========== -->
 
162
 
 
163
<A NAME="method_detail"><!-- --></A>
 
164
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
165
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
166
<TD COLSPAN=1><FONT SIZE="+2">
 
167
<B>Method Detail</B></FONT></TD>
 
168
</TR>
 
169
</TABLE>
 
170
 
 
171
<A NAME="extractScheme(java.lang.String)"><!-- --></A><H3>
 
172
extractScheme</H3>
 
173
<PRE>
 
174
public static <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> <B>extractScheme</B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A>&nbsp;challengeStr)
 
175
                            throws <A HREF="../../../../../org/apache/commons/httpclient/auth/MalformedChallengeException.html">MalformedChallengeException</A></PRE>
 
176
<DL>
 
177
<DD>Extracts authentication scheme from the given authentication 
 
178
 challenge.<DD><DL>
 
179
<DT><B>Parameters:</B><DD><CODE>challengeStr</CODE> - the authentication challenge string<DT><B>Returns:</B><DD>authentication scheme<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/MalformedChallengeException.html">MalformedChallengeException</A></CODE> - when the authentication challenge string
 
180
  is malformed<DT><B>Since: </B><DD>2.0beta1</DD>
 
181
</DL>
 
182
</DD>
 
183
</DL>
 
184
<HR>
 
185
 
 
186
<A NAME="extractParams(java.lang.String)"><!-- --></A><H3>
 
187
extractParams</H3>
 
188
<PRE>
 
189
public static <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/util/Map.html">Map</A> <B>extractParams</B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A>&nbsp;challengeStr)
 
190
                         throws <A HREF="../../../../../org/apache/commons/httpclient/auth/MalformedChallengeException.html">MalformedChallengeException</A></PRE>
 
191
<DL>
 
192
<DD>Extracts a map of challenge parameters from an authentication challenge.
 
193
 Keys in the map are lower-cased<DD><DL>
 
194
<DT><B>Parameters:</B><DD><CODE>challengeStr</CODE> - the authentication challenge string<DT><B>Returns:</B><DD>a map of authentication challenge parameters<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/MalformedChallengeException.html">MalformedChallengeException</A></CODE> - when the authentication challenge string
 
195
  is malformed<DT><B>Since: </B><DD>2.0beta1</DD>
 
196
</DL>
 
197
</DD>
 
198
</DL>
 
199
<!-- ========= END OF CLASS DATA ========= -->
 
200
<HR>
 
201
 
 
202
<!-- ========== START OF NAVBAR ========== -->
 
203
<A NAME="navbar_bottom"><!-- --></A>
 
204
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
205
<TR>
 
206
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
207
<A NAME="navbar_bottom_firstrow"><!-- --></A>
 
208
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
209
  <TR ALIGN="center" VALIGN="top">
 
210
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
211
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
212
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
213
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/AuthChallengeParser.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
214
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
215
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
216
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
217
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
218
  </TR>
 
219
</TABLE>
 
220
</TD>
 
221
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
222
</EM>
 
223
</TD>
 
224
</TR>
 
225
 
 
226
<TR>
 
227
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
228
&nbsp;PREV CLASS&nbsp;
 
229
&nbsp;<A HREF="../../../../../org/apache/commons/httpclient/auth/AuthSchemeBase.html"><B>NEXT CLASS</B></A></FONT></TD>
 
230
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
231
  <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
232
&nbsp;<A HREF="AuthChallengeParser.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 
233
</TR>
 
234
<TR>
 
235
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
236
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
237
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
238
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
239
</TR>
 
240
</TABLE>
 
241
<!-- =========== END OF NAVBAR =========== -->
 
242
 
 
243
<HR>
 
244
Copyright &copy; 2001-2004 Apache Software Foundation. All Rights Reserved.
 
245
</BODY>
 
246
</HTML>