|
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:52 GMT+01:00 2008 -->
|
|
|
6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
|
7 <TITLE>
|
|
|
8 org.apache.http.auth (HttpClient 4.0-beta1 API)
|
|
|
9 </TITLE>
|
|
|
10
|
|
|
11 <META NAME="keywords" CONTENT="org.apache.http.auth package">
|
|
|
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="org.apache.http.auth (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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
|
|
|
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
|
|
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.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 PREV PACKAGE
|
|
|
57 <A HREF="../../../../org/apache/http/auth/params/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
|
|
|
58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
59 <A HREF="../../../../index.html?org/apache/http/auth/package-summary.html" target="_top"><B>FRAMES</B></A>
|
|
|
60 <A HREF="package-summary.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 </TABLE>
|
|
|
76 <A NAME="skip-navbar_top"></A>
|
|
|
77 <!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
78
|
|
|
79 <HR>
|
|
|
80 <H2>
|
|
|
81 Package org.apache.http.auth
|
|
|
82 </H2>
|
|
|
83 The API for client-side HTTP authentication against a server,
|
|
|
84 commonly referred to as <i>HttpAuth</i>.
|
|
|
85 <P>
|
|
|
86 <B>See:</B>
|
|
|
87 <BR>
|
|
|
88 <A HREF="#package_description"><B>Description</B></A>
|
|
|
89 <P>
|
|
|
90
|
|
|
91 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
92 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
93 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
94 <B>Interface Summary</B></FONT></TH>
|
|
|
95 </TR>
|
|
|
96 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
97 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/AuthScheme.html" title="interface in org.apache.http.auth">AuthScheme</A></B></TD>
|
|
|
98 <TD>
|
|
|
99 This interface represents an abstract challenge-response oriented
|
|
|
100 authentication scheme.</TD>
|
|
|
101 </TR>
|
|
|
102 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
103 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/AuthSchemeFactory.html" title="interface in org.apache.http.auth">AuthSchemeFactory</A></B></TD>
|
|
|
104 <TD> </TD>
|
|
|
105 </TR>
|
|
|
106 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
107 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/Credentials.html" title="interface in org.apache.http.auth">Credentials</A></B></TD>
|
|
|
108 <TD>User name and password based authentication credentials.</TD>
|
|
|
109 </TR>
|
|
|
110 </TABLE>
|
|
|
111
|
|
|
112
|
|
|
113 <P>
|
|
|
114
|
|
|
115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
117 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
118 <B>Class Summary</B></FONT></TH>
|
|
|
119 </TR>
|
|
|
120 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
121 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/AUTH.html" title="class in org.apache.http.auth">AUTH</A></B></TD>
|
|
|
122 <TD>Constants and static helpers related to the HTTP authentication.</TD>
|
|
|
123 </TR>
|
|
|
124 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
125 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/AuthSchemeRegistry.html" title="class in org.apache.http.auth">AuthSchemeRegistry</A></B></TD>
|
|
|
126 <TD>Authentication scheme registry that can be used to obtain the corresponding
|
|
|
127 authentication scheme implementation for a given type of authorization challenge.</TD>
|
|
|
128 </TR>
|
|
|
129 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
130 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/AuthScope.html" title="class in org.apache.http.auth">AuthScope</A></B></TD>
|
|
|
131 <TD>The class represents an authentication scope consisting of a host name,
|
|
|
132 a port number, a realm name and an authentication scheme name which
|
|
|
133 <A HREF="../../../../org/apache/http/auth/Credentials.html" title="interface in org.apache.http.auth"><CODE>Credentials</CODE></A> apply to.</TD>
|
|
|
134 </TR>
|
|
|
135 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
136 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/AuthState.html" title="class in org.apache.http.auth">AuthState</A></B></TD>
|
|
|
137 <TD>This class provides detailed information about the state of the
|
|
|
138 authentication process.</TD>
|
|
|
139 </TR>
|
|
|
140 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
141 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/BasicUserPrincipal.html" title="class in org.apache.http.auth">BasicUserPrincipal</A></B></TD>
|
|
|
142 <TD>Basic user principal used for HTTP authentication</TD>
|
|
|
143 </TR>
|
|
|
144 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
145 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/NTCredentials.html" title="class in org.apache.http.auth">NTCredentials</A></B></TD>
|
|
|
146 <TD><A HREF="../../../../org/apache/http/auth/Credentials.html" title="interface in org.apache.http.auth"><CODE>Credentials</CODE></A> specific to the Windows platform.</TD>
|
|
|
147 </TR>
|
|
|
148 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
149 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/NTUserPrincipal.html" title="class in org.apache.http.auth">NTUserPrincipal</A></B></TD>
|
|
|
150 <TD>NT (MS Windows specific) user principal used for HTTP authentication</TD>
|
|
|
151 </TR>
|
|
|
152 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
153 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/UsernamePasswordCredentials.html" title="class in org.apache.http.auth">UsernamePasswordCredentials</A></B></TD>
|
|
|
154 <TD>Username and password <A HREF="../../../../org/apache/http/auth/Credentials.html" title="interface in org.apache.http.auth"><CODE>Credentials</CODE></A></TD>
|
|
|
155 </TR>
|
|
|
156 </TABLE>
|
|
|
157
|
|
|
158
|
|
|
159 <P>
|
|
|
160
|
|
|
161 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
162 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
163 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
164 <B>Exception Summary</B></FONT></TH>
|
|
|
165 </TR>
|
|
|
166 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
167 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/AuthenticationException.html" title="class in org.apache.http.auth">AuthenticationException</A></B></TD>
|
|
|
168 <TD>Signals a failure in authentication process</TD>
|
|
|
169 </TR>
|
|
|
170 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
171 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/InvalidCredentialsException.html" title="class in org.apache.http.auth">InvalidCredentialsException</A></B></TD>
|
|
|
172 <TD>Authentication credentials required to respond to a authentication
|
|
|
173 challenge are invalid</TD>
|
|
|
174 </TR>
|
|
|
175 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
176 <TD WIDTH="15%"><B><A HREF="../../../../org/apache/http/auth/MalformedChallengeException.html" title="class in org.apache.http.auth">MalformedChallengeException</A></B></TD>
|
|
|
177 <TD>Signals that authentication challenge is in some way invalid or
|
|
|
178 illegal in the given context</TD>
|
|
|
179 </TR>
|
|
|
180 </TABLE>
|
|
|
181
|
|
|
182
|
|
|
183 <P>
|
|
|
184 <A NAME="package_description"><!-- --></A><H2>
|
|
|
185 Package org.apache.http.auth Description
|
|
|
186 </H2>
|
|
|
187
|
|
|
188 <P>
|
|
|
189 The API for client-side HTTP authentication against a server,
|
|
|
190 commonly referred to as <i>HttpAuth</i>.
|
|
|
191 <P>
|
|
|
192
|
|
|
193 <P>
|
|
|
194 <DL>
|
|
|
195 </DL>
|
|
|
196 <HR>
|
|
|
197
|
|
|
198
|
|
|
199 <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
|
200 <A NAME="navbar_bottom"><!-- --></A>
|
|
|
201 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
|
202 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
203 <TR>
|
|
|
204 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
205 <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
|
206 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
207 <TR ALIGN="center" VALIGN="top">
|
|
|
208 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
|
209 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
|
|
|
210 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
|
|
211 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
212 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
213 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
214 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
215 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
216 </TR>
|
|
|
217 </TABLE>
|
|
|
218 </TD>
|
|
|
219 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
220 </EM>
|
|
|
221 </TD>
|
|
|
222 </TR>
|
|
|
223
|
|
|
224 <TR>
|
|
|
225 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
226 PREV PACKAGE
|
|
|
227 <A HREF="../../../../org/apache/http/auth/params/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
|
|
|
228 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
229 <A HREF="../../../../index.html?org/apache/http/auth/package-summary.html" target="_top"><B>FRAMES</B></A>
|
|
|
230 <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
231 <SCRIPT type="text/javascript">
|
|
|
232 <!--
|
|
|
233 if(window==top) {
|
|
|
234 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
235 }
|
|
|
236 //-->
|
|
|
237 </SCRIPT>
|
|
|
238 <NOSCRIPT>
|
|
|
239 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
240 </NOSCRIPT>
|
|
|
241
|
|
|
242
|
|
|
243 </FONT></TD>
|
|
|
244 </TR>
|
|
|
245 </TABLE>
|
|
|
246 <A NAME="skip-navbar_bottom"></A>
|
|
|
247 <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
248
|
|
|
249 <HR>
|
|
|
250 Copyright © 1999-2008 <a href="http://www.apache.org/">Apache Software Foundation</a>. All Rights Reserved.
|
|
|
251 </BODY>
|
|
|
252 </HTML>
|
