1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5
<!-- Generated by javadoc (build 1.5.0_11) on Sat Aug 18 11:01:01 CEST 2007 -->
6
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
8
NTLMScheme (HttpClient 3.1 API)
11
<META NAME="keywords" CONTENT="org.apache.commons.httpclient.auth.NTLMScheme class">
13
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
15
<SCRIPT type="text/javascript">
16
function windowTitle()
18
parent.document.title="NTLMScheme (HttpClient 3.1 API)";
26
<BODY BGCOLOR="white" onload="windowTitle();">
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="">
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/NTLMScheme.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>
49
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
55
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
56
<A HREF="../../../../../org/apache/commons/httpclient/auth/MalformedChallengeException.html" title="class in org.apache.commons.httpclient.auth"><B>PREV CLASS</B></A>
57
<A HREF="../../../../../org/apache/commons/httpclient/auth/RFC2617Scheme.html" title="class in org.apache.commons.httpclient.auth"><B>NEXT CLASS</B></A></FONT></TD>
58
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59
<A HREF="../../../../../index.html?org/apache/commons/httpclient/auth/NTLMScheme.html" target="_top"><B>FRAMES</B></A>
60
<A HREF="NTLMScheme.html" target="_top"><B>NO FRAMES</B></A>
61
<SCRIPT type="text/javascript">
64
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
69
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
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>
82
<A NAME="skip-navbar_top"></A>
83
<!-- ========= END OF TOP NAVBAR ========= -->
86
<!-- ======== START OF CLASS DATA ======== -->
89
org.apache.commons.httpclient.auth</FONT>
93
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
94
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.httpclient.auth.NTLMScheme</B>
97
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html" title="interface in org.apache.commons.httpclient.auth">AuthScheme</A></DD>
101
<DT><PRE>public class <B>NTLMScheme</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html" title="interface in org.apache.commons.httpclient.auth">AuthScheme</A></DL>
105
An implementation of the Microsoft proprietary NTLM authentication scheme. For a detailed
106
explanation of the NTLM scheme please see <a href="http://davenport.sourceforge.net/ntlm.html">
107
http://davenport.sourceforge.net/ntlm.html</a>.
112
<DT><B>Author:</B></DT>
113
<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>
119
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
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>
127
<TR BGCOLOR="white" CLASS="TableRowColor">
128
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#NTLMScheme()">NTLMScheme</A></B>()</CODE>
131
Default constructor for the NTLM authentication scheme.</TD>
133
<TR BGCOLOR="white" CLASS="TableRowColor">
134
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#NTLMScheme(java.lang.String)">NTLMScheme</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> challenge)</CODE>
137
Constructor for the NTLM authentication scheme.</TD>
141
<!-- ========== METHOD SUMMARY =========== -->
143
<A NAME="method_summary"><!-- --></A>
144
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
145
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
146
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
147
<B>Method Summary</B></FONT></TH>
149
<TR BGCOLOR="white" CLASS="TableRowColor">
150
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
152
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#authenticate(org.apache.commons.httpclient.Credentials, org.apache.commons.httpclient.HttpMethod)">authenticate</A></B>(<A HREF="../../../../../org/apache/commons/httpclient/Credentials.html" title="interface in org.apache.commons.httpclient">Credentials</A> credentials,
153
<A HREF="../../../../../org/apache/commons/httpclient/HttpMethod.html" title="interface in org.apache.commons.httpclient">HttpMethod</A> method)</CODE>
156
Produces NTLM authorization string for the given set of
157
<A HREF="../../../../../org/apache/commons/httpclient/Credentials.html" title="interface in org.apache.commons.httpclient"><CODE>Credentials</CODE></A>.</TD>
159
<TR BGCOLOR="white" CLASS="TableRowColor">
160
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
162
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#authenticate(org.apache.commons.httpclient.Credentials, java.lang.String, java.lang.String)">authenticate</A></B>(<A HREF="../../../../../org/apache/commons/httpclient/Credentials.html" title="interface in org.apache.commons.httpclient">Credentials</A> credentials,
163
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> method,
164
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> uri)</CODE>
167
<B>Deprecated.</B> <I>Use <A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#authenticate(org.apache.commons.httpclient.Credentials, org.apache.commons.httpclient.HttpMethod)"><CODE>authenticate(Credentials, HttpMethod)</CODE></A></I></TD>
169
<TR BGCOLOR="white" CLASS="TableRowColor">
170
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171
<CODE>static <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
172
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#authenticate(org.apache.commons.httpclient.NTCredentials, java.lang.String)">authenticate</A></B>(<A HREF="../../../../../org/apache/commons/httpclient/NTCredentials.html" title="class in org.apache.commons.httpclient">NTCredentials</A> credentials,
173
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> challenge)</CODE>
176
<B>Deprecated.</B> <I>Use non-static <A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#authenticate(org.apache.commons.httpclient.Credentials, org.apache.commons.httpclient.HttpMethod)"><CODE>authenticate(Credentials, HttpMethod)</CODE></A></I></TD>
178
<TR BGCOLOR="white" CLASS="TableRowColor">
179
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180
<CODE>static <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
181
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#authenticate(org.apache.commons.httpclient.NTCredentials, java.lang.String, java.lang.String)">authenticate</A></B>(<A HREF="../../../../../org/apache/commons/httpclient/NTCredentials.html" title="class in org.apache.commons.httpclient">NTCredentials</A> credentials,
182
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> challenge,
183
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> charset)</CODE>
186
<B>Deprecated.</B> <I>Use non-static <A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#authenticate(org.apache.commons.httpclient.Credentials, org.apache.commons.httpclient.HttpMethod)"><CODE>authenticate(Credentials, HttpMethod)</CODE></A></I></TD>
188
<TR BGCOLOR="white" CLASS="TableRowColor">
189
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
191
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#getID()">getID</A></B>()</CODE>
194
<B>Deprecated.</B> <I>no longer used</I></TD>
196
<TR BGCOLOR="white" CLASS="TableRowColor">
197
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
199
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#getParameter(java.lang.String)">getParameter</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE>
202
Returns the authentication parameter with the given name, if available.</TD>
204
<TR BGCOLOR="white" CLASS="TableRowColor">
205
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
207
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#getRealm()">getRealm</A></B>()</CODE>
210
The concept of an authentication realm is not supported by the NTLM
211
authentication scheme.</TD>
213
<TR BGCOLOR="white" CLASS="TableRowColor">
214
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
216
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#getSchemeName()">getSchemeName</A></B>()</CODE>
219
Returns textual designation of the NTLM authentication scheme.</TD>
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/commons/httpclient/auth/NTLMScheme.html#isComplete()">isComplete</A></B>()</CODE>
227
Tests if the NTLM authentication process has been completed.</TD>
229
<TR BGCOLOR="white" CLASS="TableRowColor">
230
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231
<CODE> boolean</CODE></FONT></TD>
232
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#isConnectionBased()">isConnectionBased</A></B>()</CODE>
235
Returns <tt>true</tt>.</TD>
237
<TR BGCOLOR="white" CLASS="TableRowColor">
238
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239
<CODE> void</CODE></FONT></TD>
240
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#processChallenge(java.lang.String)">processChallenge</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> challenge)</CODE>
243
Processes the NTLM challenge.</TD>
246
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
247
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
248
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
249
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
251
<TR BGCOLOR="white" CLASS="TableRowColor">
252
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
258
<!-- ========= CONSTRUCTOR DETAIL ======== -->
260
<A NAME="constructor_detail"><!-- --></A>
261
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
262
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
263
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
264
<B>Constructor Detail</B></FONT></TH>
268
<A NAME="NTLMScheme()"><!-- --></A><H3>
271
public <B>NTLMScheme</B>()</PRE>
273
<DD>Default constructor for the NTLM authentication scheme.
276
<DT><B>Since:</B></DT>
282
<A NAME="NTLMScheme(java.lang.String)"><!-- --></A><H3>
285
public <B>NTLMScheme</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> challenge)
286
throws <A HREF="../../../../../org/apache/commons/httpclient/auth/MalformedChallengeException.html" title="class in org.apache.commons.httpclient.auth">MalformedChallengeException</A></PRE>
288
<DD>Constructor for the NTLM authentication scheme.
291
<DT><B>Parameters:</B><DD><CODE>challenge</CODE> - The authentication challenge
293
<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/MalformedChallengeException.html" title="class in org.apache.commons.httpclient.auth">MalformedChallengeException</A></CODE> - is thrown if the authentication challenge
297
<!-- ============ METHOD DETAIL ========== -->
299
<A NAME="method_detail"><!-- --></A>
300
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
301
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
302
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
303
<B>Method Detail</B></FONT></TH>
307
<A NAME="processChallenge(java.lang.String)"><!-- --></A><H3>
308
processChallenge</H3>
310
public void <B>processChallenge</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> challenge)
311
throws <A HREF="../../../../../org/apache/commons/httpclient/auth/MalformedChallengeException.html" title="class in org.apache.commons.httpclient.auth">MalformedChallengeException</A></PRE>
313
<DD>Processes the NTLM challenge.
316
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#processChallenge(java.lang.String)">processChallenge</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html" title="interface in org.apache.commons.httpclient.auth">AuthScheme</A></CODE></DL>
319
<DT><B>Parameters:</B><DD><CODE>challenge</CODE> - the challenge string
321
<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/MalformedChallengeException.html" title="class in org.apache.commons.httpclient.auth">MalformedChallengeException</A></CODE> - is thrown if the authentication challenge
322
is malformed<DT><B>Since:</B></DT>
329
<A NAME="isComplete()"><!-- --></A><H3>
332
public boolean <B>isComplete</B>()</PRE>
334
<DD>Tests if the NTLM authentication process has been completed.
337
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#isComplete()">isComplete</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html" title="interface in org.apache.commons.httpclient.auth">AuthScheme</A></CODE></DL>
341
<DT><B>Returns:</B><DD><tt>true</tt> if Basic authorization has been processed,
342
<tt>false</tt> otherwise.<DT><B>Since:</B></DT>
349
<A NAME="getSchemeName()"><!-- --></A><H3>
352
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getSchemeName</B>()</PRE>
354
<DD>Returns textual designation of the NTLM authentication scheme.
357
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#getSchemeName()">getSchemeName</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html" title="interface in org.apache.commons.httpclient.auth">AuthScheme</A></CODE></DL>
361
<DT><B>Returns:</B><DD><code>ntlm</code></DL>
366
<A NAME="getRealm()"><!-- --></A><H3>
369
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getRealm</B>()</PRE>
371
<DD>The concept of an authentication realm is not supported by the NTLM
372
authentication scheme. Always returns <code>null</code>.
375
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#getRealm()">getRealm</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html" title="interface in org.apache.commons.httpclient.auth">AuthScheme</A></CODE></DL>
379
<DT><B>Returns:</B><DD><code>null</code></DL>
384
<A NAME="getID()"><!-- --></A><H3>
387
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getID</B>()</PRE>
389
<DD><B>Deprecated.</B> <I>no longer used</I>
391
<DD>Returns a String identifying the authentication challenge. This is
392
used, in combination with the host and port to determine if
393
authorization has already been attempted or not. Schemes which
394
require multiple requests to complete the authentication should
395
return a different value for each stage in the request.
397
<p>Additionally, the ID should take into account any changes to the
398
authentication challenge and return a different value when appropriate.
399
For example when the realm changes in basic authentication it should be
400
considered a different authentication attempt and a different value should
404
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#getID()">getID</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html" title="interface in org.apache.commons.httpclient.auth">AuthScheme</A></CODE></DL>
408
<DT><B>Returns:</B><DD>String a String identifying the authentication challenge. The
409
returned value may be null.</DL>
414
<A NAME="getParameter(java.lang.String)"><!-- --></A><H3>
417
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getParameter</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE>
419
<DD>Returns the authentication parameter with the given name, if available.
421
<p>There are no valid parameters for NTLM authentication so this method always returns
425
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#getParameter(java.lang.String)">getParameter</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html" title="interface in org.apache.commons.httpclient.auth">AuthScheme</A></CODE></DL>
428
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the parameter to be returned
429
<DT><B>Returns:</B><DD>the parameter with the given name</DL>
434
<A NAME="isConnectionBased()"><!-- --></A><H3>
435
isConnectionBased</H3>
437
public boolean <B>isConnectionBased</B>()</PRE>
439
<DD>Returns <tt>true</tt>. NTLM authentication scheme is connection based.
442
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#isConnectionBased()">isConnectionBased</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html" title="interface in org.apache.commons.httpclient.auth">AuthScheme</A></CODE></DL>
446
<DT><B>Returns:</B><DD><tt>true</tt>.<DT><B>Since:</B></DT>
453
<A NAME="authenticate(org.apache.commons.httpclient.NTCredentials, java.lang.String)"><!-- --></A><H3>
456
public static <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>authenticate</B>(<A HREF="../../../../../org/apache/commons/httpclient/NTCredentials.html" title="class in org.apache.commons.httpclient">NTCredentials</A> credentials,
457
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> challenge)
458
throws <A HREF="../../../../../org/apache/commons/httpclient/auth/AuthenticationException.html" title="class in org.apache.commons.httpclient.auth">AuthenticationException</A></PRE>
460
<DD><B>Deprecated.</B> <I>Use non-static <A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#authenticate(org.apache.commons.httpclient.Credentials, org.apache.commons.httpclient.HttpMethod)"><CODE>authenticate(Credentials, HttpMethod)</CODE></A></I>
462
<DD>Create a NTLM authorization string for the given
463
challenge and NT credentials.
469
<DT><B>Parameters:</B><DD><CODE>challenge</CODE> - The challenge.<DD><CODE>credentials</CODE> - <A HREF="../../../../../org/apache/commons/httpclient/NTCredentials.html" title="class in org.apache.commons.httpclient"><CODE>NTCredentials</CODE></A>
470
<DT><B>Returns:</B><DD>a ntlm authorization string
472
<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthenticationException.html" title="class in org.apache.commons.httpclient.auth">AuthenticationException</A></CODE> - is thrown if authentication fails</DL>
477
<A NAME="authenticate(org.apache.commons.httpclient.NTCredentials, java.lang.String, java.lang.String)"><!-- --></A><H3>
480
public static <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>authenticate</B>(<A HREF="../../../../../org/apache/commons/httpclient/NTCredentials.html" title="class in org.apache.commons.httpclient">NTCredentials</A> credentials,
481
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> challenge,
482
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> charset)
483
throws <A HREF="../../../../../org/apache/commons/httpclient/auth/AuthenticationException.html" title="class in org.apache.commons.httpclient.auth">AuthenticationException</A></PRE>
485
<DD><B>Deprecated.</B> <I>Use non-static <A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#authenticate(org.apache.commons.httpclient.Credentials, org.apache.commons.httpclient.HttpMethod)"><CODE>authenticate(Credentials, HttpMethod)</CODE></A></I>
487
<DD>Create a NTLM authorization string for the given
488
challenge and NT credentials.
494
<DT><B>Parameters:</B><DD><CODE>challenge</CODE> - The challenge.<DD><CODE>credentials</CODE> - <A HREF="../../../../../org/apache/commons/httpclient/NTCredentials.html" title="class in org.apache.commons.httpclient"><CODE>NTCredentials</CODE></A><DD><CODE>charset</CODE> - The charset to use for encoding the credentials
495
<DT><B>Returns:</B><DD>a ntlm authorization string
497
<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthenticationException.html" title="class in org.apache.commons.httpclient.auth">AuthenticationException</A></CODE> - is thrown if authentication fails<DT><B>Since:</B></DT>
504
<A NAME="authenticate(org.apache.commons.httpclient.Credentials, java.lang.String, java.lang.String)"><!-- --></A><H3>
507
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>authenticate</B>(<A HREF="../../../../../org/apache/commons/httpclient/Credentials.html" title="interface in org.apache.commons.httpclient">Credentials</A> credentials,
508
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> method,
509
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> uri)
510
throws <A HREF="../../../../../org/apache/commons/httpclient/auth/AuthenticationException.html" title="class in org.apache.commons.httpclient.auth">AuthenticationException</A></PRE>
512
<DD><B>Deprecated.</B> <I>Use <A HREF="../../../../../org/apache/commons/httpclient/auth/NTLMScheme.html#authenticate(org.apache.commons.httpclient.Credentials, org.apache.commons.httpclient.HttpMethod)"><CODE>authenticate(Credentials, HttpMethod)</CODE></A></I>
514
<DD>Produces NTLM authorization string for the given set of
515
<A HREF="../../../../../org/apache/commons/httpclient/Credentials.html" title="interface in org.apache.commons.httpclient"><CODE>Credentials</CODE></A>.
518
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#authenticate(org.apache.commons.httpclient.Credentials, java.lang.String, java.lang.String)">authenticate</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html" title="interface in org.apache.commons.httpclient.auth">AuthScheme</A></CODE></DL>
521
<DT><B>Parameters:</B><DD><CODE>credentials</CODE> - The set of credentials to be used for athentication<DD><CODE>method</CODE> - Method name is ignored by the NTLM authentication scheme<DD><CODE>uri</CODE> - URI is ignored by the NTLM authentication scheme
522
<DT><B>Returns:</B><DD>an NTLM authorization string
524
<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/InvalidCredentialsException.html" title="class in org.apache.commons.httpclient.auth">InvalidCredentialsException</A></CODE> - if authentication credentials
525
are not valid or not applicable for this authentication scheme
526
<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthenticationException.html" title="class in org.apache.commons.httpclient.auth">AuthenticationException</A></CODE> - if authorization string cannot
527
be generated due to an authentication failure<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/commons/httpclient/HttpMethod.html#getName()"><CODE>HttpMethod.getName()</CODE></A>,
528
<A HREF="../../../../../org/apache/commons/httpclient/HttpMethod.html#getPath()"><CODE>HttpMethod.getPath()</CODE></A></DL>
533
<A NAME="authenticate(org.apache.commons.httpclient.Credentials, org.apache.commons.httpclient.HttpMethod)"><!-- --></A><H3>
536
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>authenticate</B>(<A HREF="../../../../../org/apache/commons/httpclient/Credentials.html" title="interface in org.apache.commons.httpclient">Credentials</A> credentials,
537
<A HREF="../../../../../org/apache/commons/httpclient/HttpMethod.html" title="interface in org.apache.commons.httpclient">HttpMethod</A> method)
538
throws <A HREF="../../../../../org/apache/commons/httpclient/auth/AuthenticationException.html" title="class in org.apache.commons.httpclient.auth">AuthenticationException</A></PRE>
540
<DD>Produces NTLM authorization string for the given set of
541
<A HREF="../../../../../org/apache/commons/httpclient/Credentials.html" title="interface in org.apache.commons.httpclient"><CODE>Credentials</CODE></A>.
544
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#authenticate(org.apache.commons.httpclient.Credentials, org.apache.commons.httpclient.HttpMethod)">authenticate</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html" title="interface in org.apache.commons.httpclient.auth">AuthScheme</A></CODE></DL>
547
<DT><B>Parameters:</B><DD><CODE>credentials</CODE> - The set of credentials to be used for athentication<DD><CODE>method</CODE> - The method being authenticated
548
<DT><B>Returns:</B><DD>an NTLM authorization string
550
<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/InvalidCredentialsException.html" title="class in org.apache.commons.httpclient.auth">InvalidCredentialsException</A></CODE> - if authentication credentials
551
are not valid or not applicable for this authentication scheme
552
<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthenticationException.html" title="class in org.apache.commons.httpclient.auth">AuthenticationException</A></CODE> - if authorization string cannot
553
be generated due to an authentication failure<DT><B>Since:</B></DT>
558
<!-- ========= END OF CLASS DATA ========= -->
562
<!-- ======= START OF BOTTOM NAVBAR ====== -->
563
<A NAME="navbar_bottom"><!-- --></A>
564
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
565
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
567
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
568
<A NAME="navbar_bottom_firstrow"><!-- --></A>
569
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
570
<TR ALIGN="center" VALIGN="top">
571
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
572
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
573
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
574
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/NTLMScheme.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
575
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
576
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
577
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
578
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
582
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
588
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
589
<A HREF="../../../../../org/apache/commons/httpclient/auth/MalformedChallengeException.html" title="class in org.apache.commons.httpclient.auth"><B>PREV CLASS</B></A>
590
<A HREF="../../../../../org/apache/commons/httpclient/auth/RFC2617Scheme.html" title="class in org.apache.commons.httpclient.auth"><B>NEXT CLASS</B></A></FONT></TD>
591
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
592
<A HREF="../../../../../index.html?org/apache/commons/httpclient/auth/NTLMScheme.html" target="_top"><B>FRAMES</B></A>
593
<A HREF="NTLMScheme.html" target="_top"><B>NO FRAMES</B></A>
594
<SCRIPT type="text/javascript">
597
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
602
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
609
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
610
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
611
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
612
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
615
<A NAME="skip-navbar_bottom"></A>
616
<!-- ======== END OF BOTTOM NAVBAR ======= -->
619
Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.