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

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#authenticate(org.apache.commons.httpclient.Credentials, java.lang.String, java.lang.String)">authenticate</A>(<A HREF="../../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A> credentials,

117

<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> method,

118

<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> uri)</CODE>

119

120

121

Produces an authorization string for the given set of <A HREF="../../../../../org/apache/commons/httpclient/Credentials.html"><CODE>Credentials</CODE></A>,

122

method name and URI using the given authentication scheme.</TD>

123

</TR>

124

125

126

<CODE> <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A></CODE></TD>

127

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#getID()">getID</A>()</CODE>

128

129

130

Returns a String identifying the authentication challenge.</TD>

131

</TR>

132

133

134

<CODE> <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A></CODE></TD>

135

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#getParameter(java.lang.String)">getParameter</A>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> name)</CODE>

136

137

138

Returns authentication parameter with the given name, if available.</TD>

139

</TR>

140

141

142

<CODE> <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A></CODE></TD>

143

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#getRealm()">getRealm</A>()</CODE>

144

145

146

Returns authentication realm.</TD>

147

</TR>

148

149

150

<CODE> <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A></CODE></TD>

151

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html#getSchemeName()">getSchemeName</A>()</CODE>

152

153

154

Returns textual designation of the given authentication scheme.</TD>

155

</TR>

156

</TABLE>

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

Method Detail</TD>

173

</TR>

174

</TABLE>

175

176

177

getSchemeName</H3>

178

<PRE>

179

public <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> getSchemeName()</PRE>

180

<DL>

181

<DD>Returns textual designation of the given authentication scheme.<DD><DL>

182

<DT>Returns:<DD>the name of the given authentication scheme</DL>

183

</DD>

184

</DL>

185

<HR>

186

187

188

getParameter</H3>

189

<PRE>

190

public <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> getParameter(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> name)</PRE>

191

<DL>

192

<DD>Returns authentication parameter with the given name, if available.<DD><DL>

193

<DT>Parameters:<DD><CODE>name</CODE> - The name of the parameter to be returned<DT>Returns:<DD>the parameter with the given name</DL>

194

</DD>

195

</DL>

196

<HR>

197

198

199

getRealm</H3>

200

<PRE>

201

public <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> getRealm()</PRE>

202

<DL>

203

<DD>Returns authentication realm. If the concept of an authentication

204

realm is not applicable to the given authentication scheme, returns

205

206

<DT>Returns:<DD>the authentication realm</DL>

207

</DD>

208

</DL>

209

<HR>

210

211

212

getID</H3>

213

<PRE>

214

public <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> getID()</PRE>

215

<DL>

216

<DD>Returns a String identifying the authentication challenge. This is

217

used, in combination with the host and port to determine if

218

authorization has already been attempted or not. Schemes which

219

require multiple requests to complete the authentication should

220

return a different value for each stage in the request.

221

222

Additionally, the ID should take into account any changes to the

223

authentication challenge and return a different value when appropriate.

224

For example when the realm changes in basic authentication it should be

225

considered a different authentication attempt and a different value should

226

be returned.<DD><DL>

227

<DT>Returns:<DD>String a String identifying the authentication challenge. The

228

returned value may be null.</DL>

229

</DD>

230

</DL>

231

<HR>

232

233

234

authenticate</H3>

235

<PRE>

236

public <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> authenticate(<A HREF="../../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A> credentials,

237

<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> method,

238

<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> uri)

239

throws <A HREF="../../../../../org/apache/commons/httpclient/auth/AuthenticationException.html">AuthenticationException</A></PRE>

240

<DL>

241

<DD>Produces an authorization string for the given set of <A HREF="../../../../../org/apache/commons/httpclient/Credentials.html"><CODE>Credentials</CODE></A>,

242

method name and URI using the given authentication scheme.<DD><DL>

243

<DT>Parameters:<DD><CODE>credentials</CODE> - The set of credentials to be used for athentication<DD><CODE>method</CODE> - The name of the method that requires authorization.

244

This parameter may be ignored, if it is irrelevant

245

or not applicable to the given authentication scheme<DD><CODE>uri</CODE> - The URI for which authorization is needed.

246

This parameter may be ignored, if it is irrelevant or not

247

applicable to the given authentication scheme<DT>Returns:<DD>the authorization string<DT>Throws:<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/auth/AuthenticationException.html">AuthenticationException</A></CODE> - if authorization string cannot

248

be generated due to an authentication failure<DT>See Also: <DD><A HREF="../../../../../org/apache/commons/httpclient/HttpMethod.html#getName()"><CODE>HttpMethod.getName()</CODE></A>,

249

<A HREF="../../../../../org/apache/commons/httpclient/HttpMethod.html#getPath()"><CODE>HttpMethod.getPath()</CODE></A></DL>

250

</DD>

251

</DL>

252

253

<HR>

254

255

256

257

258

<TR>

259

260

261

262

263

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html">Overview</A> </TD>

264

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A> </TD>

265

<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  Class </TD>

266

267

268

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html">Deprecated</A> </TD>

269

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html">Index</A> </TD>

270

271

</TR>

272

</TABLE>

273

</TD>

274

275

276

</TD>

277

</TR>

278

279

<TR>

280

281

 PREV CLASS 

282

NEXT CLASS</TD>

283

284

<A HREF="../../../../../index.html" TARGET="_top">FRAMES</A>

285

<A HREF="AuthScheme.html" TARGET="_top">NO FRAMES</A></TD>

286

</TR>

287

<TR>

288

289

SUMMARY:  INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></TD>

290

291

DETAIL:  FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></TD>

292

</TR>

293

</TABLE>

294

295

296

<HR>

297

298

</BODY>

299

</HTML>

Older »