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

<DT>Author: <DD><a href="mailto:remm@apache.org">Remy Maucherat</a>, Rodney Waldhoff, <a href="mailto:jsdever@apache.org">Jeff Dever</a>, Sean C. Sullivan, <a href="mailto:becke@u.washington.edu">Michael Becke</a>, <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>, <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>, <a href="mailto:adrian@intencha.com">Adrian Sutton</a></DD>

</DL>

<HR>

Field Summary</TD>

</TR>

100

101

102

<CODE>static <A HREF="../../../../org/apache/commons/httpclient/auth/HttpAuthRealm.html">HttpAuthRealm</A></CODE></TD>

103

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#DEFAULT_AUTH_REALM">DEFAULT_AUTH_REALM</A></CODE>

104

105

106

The default authentication realm.</TD>

107

</TR>

108

109

110

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

111

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#PREEMPTIVE_DEFAULT">PREEMPTIVE_DEFAULT</A></CODE>

112

113

114

Deprecated. This field and feature will be removed following HttpClient 3.0.</TD>

115

</TR>

116

117

118

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

119

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#PREEMPTIVE_PROPERTY">PREEMPTIVE_PROPERTY</A></CODE>

120

121

122

Deprecated. This field and feature will be removed following HttpClient 3.0.</TD>

123

</TR>

124

</TABLE>

125

126

127

128

129

130

131

132

Constructor Summary</TD>

133

</TR>

134

135

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

136

137

138

Default constructor.</TD>

139

</TR>

140

</TABLE>

141

142

143

144

145

146

147

148

Method Summary</TD>

149

</TR>

150

151

152

153

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#addCookie(org.apache.commons.httpclient.Cookie)">addCookie</A>(<A HREF="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</A> cookie)</CODE>

154

155

156

Adds an <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>HTTP cookie</CODE></A>, replacing any existing equivalent cookies.</TD>

157

</TR>

158

159

160

161

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#addCookies(org.apache.commons.httpclient.Cookie[])">addCookies</A>(<A HREF="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</A>[] cookies)</CODE>

162

163

164

Adds an array of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>HTTP cookies</CODE></A>.</TD>

165

</TR>

166

167

168

169

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getCookiePolicy()">getCookiePolicy</A>()</CODE>

170

171

172

Returns the current <A HREF="../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html"><CODE>cookie policy</CODE></A> for this

173

HTTP state.</TD>

174

</TR>

175

176

177

<CODE> <A HREF="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</A>[]</CODE></TD>

178

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getCookies()">getCookies</A>()</CODE>

179

180

181

Returns an array of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookies</CODE></A> that this HTTP

182

state currently contains.</TD>

183

</TR>

184

185

186

<CODE> <A HREF="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</A>[]</CODE></TD>

187

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getCookies(java.lang.String, int, java.lang.String, boolean)">getCookies</A>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> domain,

188

int port,

189

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

190

boolean secure)</CODE>

191

192

193

Deprecated. use <A HREF="../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#match(java.lang.String, int, java.lang.String, boolean, org.apache.commons.httpclient.Cookie)"><CODE>CookieSpec.match(String, int, String, boolean, Cookie)</CODE></A></TD>

194

</TR>

195

196

197

<CODE> <A HREF="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</A>[]</CODE></TD>

198

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getCookies(java.lang.String, int, java.lang.String, boolean, java.util.Date)">getCookies</A>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> domain,

199

int port,

200

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

201

boolean secure,

202

203

204

205

Deprecated. use CookieSpec#match(String, int, String, boolean, Cookie)</TD>

206

</TR>

207

208

209

<CODE> <A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A></CODE></TD>

210

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

211

212

213

Deprecated. This method does not distinguish between realms on different

214

servers with the same name. Use <A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getCredentials(java.lang.String, java.lang.String)"><CODE>getCredentials(String, String)</CODE></A>

215

instead.</TD>

216

</TR>

217

218

219

<CODE> <A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A></CODE></TD>

220

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getCredentials(java.lang.String, java.lang.String)">getCredentials</A>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> realm,

221

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

222

223

224

Get the <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> for the given authentication realm on the

225

given host.</TD>

226

</TR>

227

228

229

<CODE> <A HREF="../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</A></CODE></TD>

230

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getHttpConnectionManager()">getHttpConnectionManager</A>()</CODE>

231

232

233

Deprecated. Connection manager is controlled by the HttpClient class.

234

Use <A HREF="../../../../org/apache/commons/httpclient/HttpClient.html#getHttpConnectionManager()"><CODE>HttpClient.getHttpConnectionManager()</CODE></A> instead.</TD>

235

</TR>

236

237

238

<CODE> <A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A></CODE></TD>

239

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

240

241

242

Deprecated. This method does not distinguish between realms on different hosts.

243

Use <A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getProxyCredentials(java.lang.String, java.lang.String)"><CODE>getProxyCredentials(String, String)</CODE></A> instead.</TD>

244

</TR>

245

246

247

<CODE> <A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A></CODE></TD>

248

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getProxyCredentials(java.lang.String, java.lang.String)">getProxyCredentials</A>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> realm,

249

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

250

251

252

Get the <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> for the proxy host with the given

253

authentication realm.</TD>

254

</TR>

255

256

257

<CODE> boolean</CODE></TD>

258

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#isAuthenticationPreemptive()">isAuthenticationPreemptive</A>()</CODE>

259

260

261

Returns <tt>true</tt> if preemptive authentication should be

262

attempted, <tt>false</tt> otherwise.</TD>

263

</TR>

264

265

266

<CODE> boolean</CODE></TD>

267

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#purgeExpiredCookies()">purgeExpiredCookies</A>()</CODE>

268

269

270

Removes all of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookies</CODE></A> in this HTTP state

271

that have expired according to the current system time.</TD>

272

</TR>

273

274

275

<CODE> boolean</CODE></TD>

276

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#purgeExpiredCookies(java.util.Date)">purgeExpiredCookies</A>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/util/Date.html">Date</A> date)</CODE>

277

278

279

Removes all of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookies</CODE></A> in this HTTP state

280

that have expired by the specified <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/util/Date.html"><CODE>date</CODE></A>.</TD>

281

</TR>

282

283

284

285

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setAuthenticationPreemptive(boolean)">setAuthenticationPreemptive</A>(boolean value)</CODE>

286

287

288

          Defines whether preemptive authentication should be

289

attempted.</TD>

290

</TR>

291

292

293

294

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setCookiePolicy(int)">setCookiePolicy</A>(int policy)</CODE>

295

296

297

Sets the current <A HREF="../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html"><CODE>cookie policy</CODE></A> for this HTTP

298

state to one of the following supported policies:

299

<A HREF="../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#COMPATIBILITY"><CODE>CookiePolicy.COMPATIBILITY</CODE></A>,

300

<A HREF="../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#NETSCAPE_DRAFT"><CODE>CookiePolicy.NETSCAPE_DRAFT</CODE></A> or

301

<A HREF="../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#RFC2109"><CODE>CookiePolicy.RFC2109</CODE></A>.</TD>

302

</TR>

303

304

305

306

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setCredentials(java.lang.String, org.apache.commons.httpclient.Credentials)">setCredentials</A>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> realm,

307

<A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A> credentials)</CODE>

308

309

310

Deprecated. This method does not distinguish between realms with the

311

same name on different hosts.

312

Use <A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setCredentials(java.lang.String, java.lang.String, org.apache.commons.httpclient.Credentials)"><CODE>setCredentials(String, String, Credentials)</CODE></A> instead.</TD>

313

</TR>

314

315

316

317

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setCredentials(java.lang.String, java.lang.String, org.apache.commons.httpclient.Credentials)">setCredentials</A>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> realm,

318

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

319

<A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A> credentials)</CODE>

320

321

322

Sets the <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> for the given authentication

323

realm on the given host.</TD>

324

</TR>

325

326

327

328

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setHttpConnectionManager(org.apache.commons.httpclient.HttpConnectionManager)">setHttpConnectionManager</A>(<A HREF="../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</A> httpConnectionManager)</CODE>

329

330

331

Deprecated. Connection manager is controlled by the HttpClient class.

332

Use <A HREF="../../../../org/apache/commons/httpclient/HttpClient.html#setHttpConnectionManager(org.apache.commons.httpclient.HttpConnectionManager)"><CODE>HttpClient.setHttpConnectionManager(HttpConnectionManager)</CODE></A> instead.</TD>

333

</TR>

334

335

336

337

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setProxyCredentials(java.lang.String, org.apache.commons.httpclient.Credentials)">setProxyCredentials</A>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> realm,

338

<A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A> credentials)</CODE>

339

340

341

Deprecated. This method does not differentiate between realms with

342

the same name on different servers. Use

343

<A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setProxyCredentials(java.lang.String, java.lang.String, org.apache.commons.httpclient.Credentials)"><CODE>setProxyCredentials(String, String, Credentials)</CODE></A> instead.</TD>

344

</TR>

345

346

347

348

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setProxyCredentials(java.lang.String, java.lang.String, org.apache.commons.httpclient.Credentials)">setProxyCredentials</A>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> realm,

349

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

350

<A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A> credentials)</CODE>

351

352

353

Sets the <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> for the given proxy authentication

354

realm on the given proxy host.</TD>

355

</TR>

356

357

358

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

359

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#toString()">toString</A>()</CODE>

360

361

362

Returns a string representation of this HTTP state.</TD>

363

</TR>

364

</TABLE>

365

366

367

368

<TD>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">Object</A></TD>

369

</TR>

370

371

<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#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>

372

</TR>

373

</TABLE>

374

375

376

377

378

379

380

381

382

383

Field Detail</TD>

384

</TR>

385

</TABLE>

386

387

388

PREEMPTIVE_PROPERTY</H3>

389

<PRE>

390

public static final <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> PREEMPTIVE_PROPERTY</PRE>

391

<DL>

392

<DD>Deprecated. This field and feature will be removed following HttpClient 3.0.

393

394

<DD>The boolean system property name to turn on preemptive authentication.</DL>

395

<HR>

396

397

398

PREEMPTIVE_DEFAULT</H3>

399

<PRE>

400

public static final <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> PREEMPTIVE_DEFAULT</PRE>

401

<DL>

402

<DD>Deprecated. This field and feature will be removed following HttpClient 3.0.

403

404

<DD>The default value for <A HREF="../../../../org/apache/commons/httpclient/HttpState.html#PREEMPTIVE_PROPERTY"><CODE>PREEMPTIVE_PROPERTY</CODE></A>.</DL>

405

<HR>

406

407

408

DEFAULT_AUTH_REALM</H3>

409

<PRE>

410

public static final <A HREF="../../../../org/apache/commons/httpclient/auth/HttpAuthRealm.html">HttpAuthRealm</A> DEFAULT_AUTH_REALM</PRE>

411

<DL>

412

<DD>The default authentication realm.</DL>

413

414

415

416

417

418

419

420

Constructor Detail</TD>

421

</TR>

422

</TABLE>

423

424

425

HttpState</H3>

426

<PRE>

427

public HttpState()</PRE>

428

<DL>

429

<DD>Default constructor.</DL>

430

431

432

433

434

435

436

437

Method Detail</TD>

438

</TR>

439

</TABLE>

440

441

442

addCookie</H3>

443

<PRE>

444

public void addCookie(<A HREF="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</A> cookie)</PRE>

445

<DL>

446

<DD>Adds an <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>HTTP cookie</CODE></A>, replacing any existing equivalent cookies.

447

If the given cookie has already expired it will not be added, but existing

448

values will still be removed.<DD><DL>

449

<DT>Parameters:<DD><CODE>cookie</CODE> - the <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookie</CODE></A> to be added<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#addCookies(org.apache.commons.httpclient.Cookie[])"><CODE>addCookies(Cookie[])</CODE></A></DL>

450

</DD>

451

</DL>

452

<HR>

453

454

455

addCookies</H3>

456

<PRE>

457

public void addCookies(<A HREF="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</A>[] cookies)</PRE>

458

<DL>

459

<DD>Adds an array of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>HTTP cookies</CODE></A>. Cookies are added individually and

460

in the given array order. If any of the given cookies has already expired it will

461

not be added, but existing values will still be removed.<DD><DL>

462

<DT>Parameters:<DD><CODE>cookies</CODE> - the <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookies</CODE></A> to be added<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#addCookie(org.apache.commons.httpclient.Cookie)"><CODE>addCookie(Cookie)</CODE></A></DL>

463

</DD>

464

</DL>

465

<HR>

466

467

468

getCookies</H3>

469

<PRE>

470

public <A HREF="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</A>[] getCookies()</PRE>

471

<DL>

472

<DD>Returns an array of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookies</CODE></A> that this HTTP

473

state currently contains.<DD><DL>

474

<DT>Returns:<DD>an array of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookies</CODE></A>.<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getCookies(java.lang.String, int, java.lang.String, boolean, java.util.Date)"><CODE>getCookies(String, int, String, boolean, java.util.Date)</CODE></A></DL>

475

</DD>

476

</DL>

477

<HR>

478

479

480

getCookies</H3>

481

<PRE>

482

public <A HREF="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</A>[] getCookies(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> domain,

483

int port,

484

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

485

boolean secure,

486

487

<DL>

488

<DD>Deprecated. use CookieSpec#match(String, int, String, boolean, Cookie)

489

490

<DD>Returns an array of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookies</CODE></A> in this HTTP

491

state that match the given request parameters.<DD><DL>

492

<DT>Parameters:<DD><CODE>domain</CODE> - the request domain<DD><CODE>port</CODE> - the request port<DD><CODE>path</CODE> - the request path<DD><CODE>secure</CODE> - <code>true</code> when using HTTPS<DD><CODE>now</CODE> - the <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/util/Date.html"><CODE>date</CODE></A> by which expiration is determined<DT>Returns:<DD>an array of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookies</CODE></A>.<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getCookies()"><CODE>getCookies()</CODE></A></DL>

493

</DD>

494

</DL>

495

<HR>

496

497

498

getCookies</H3>

499

<PRE>

500

public <A HREF="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</A>[] getCookies(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> domain,

501

int port,

502

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

503

boolean secure)</PRE>

504

<DL>

505

<DD>Deprecated. use <A HREF="../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#match(java.lang.String, int, java.lang.String, boolean, org.apache.commons.httpclient.Cookie)"><CODE>CookieSpec.match(String, int, String, boolean, Cookie)</CODE></A>

506

507

<DD>Returns an array of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookies</CODE></A> in this HTTP

508

state that match the given request parameters.<DD><DL>

509

<DT>Parameters:<DD><CODE>domain</CODE> - the request domain<DD><CODE>port</CODE> - the request port<DD><CODE>path</CODE> - the request path<DD><CODE>secure</CODE> - <code>true</code> when using HTTPS<DT>Returns:<DD>an array of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookies</CODE></A>.<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getCookies()"><CODE>getCookies()</CODE></A></DL>

510

</DD>

511

</DL>

512

<HR>

513

514

515

purgeExpiredCookies</H3>

516

<PRE>

517

public boolean purgeExpiredCookies()</PRE>

518

<DL>

519

<DD>Removes all of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookies</CODE></A> in this HTTP state

520

that have expired according to the current system time.<DD><DL>

521

<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#purgeExpiredCookies(java.util.Date)"><CODE>purgeExpiredCookies(java.util.Date)</CODE></A></DL>

522

</DD>

523

</DL>

524

<HR>

525

526

527

purgeExpiredCookies</H3>

528

<PRE>

529

public boolean purgeExpiredCookies(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/util/Date.html">Date</A> date)</PRE>

530

<DL>

531

<DD>Removes all of <A HREF="../../../../org/apache/commons/httpclient/Cookie.html"><CODE>cookies</CODE></A> in this HTTP state

532

that have expired by the specified <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/util/Date.html"><CODE>date</CODE></A>.<DD><DL>

533

<DT>Parameters:<DD><CODE>date</CODE> - The <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/util/Date.html"><CODE>date</CODE></A> to compare against.<DT>Returns:<DD>true if any cookies were purged.<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/Cookie.html#isExpired(java.util.Date)"><CODE>Cookie.isExpired(java.util.Date)</CODE></A>,

534

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

535

</DD>

536

</DL>

537

<HR>

538

539

540

getCookiePolicy</H3>

541

<PRE>

542

public int getCookiePolicy()</PRE>

543

<DL>

544

<DD>Returns the current <A HREF="../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html"><CODE>cookie policy</CODE></A> for this

545

HTTP state.<DD><DL>

546

<DT>Returns:<DD>The <A HREF="../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html"><CODE>cookie policy</CODE></A>.</DL>

547

</DD>

548

</DL>

549

<HR>

550

551

552

setAuthenticationPreemptive</H3>

553

<PRE>

554

public void setAuthenticationPreemptive(boolean value)</PRE>

555

<DL>

556

<DD>Defines whether preemptive authentication should be

557

attempted.<DD><DL>

558

<DT>Parameters:<DD><CODE>value</CODE> - <tt>true</tt> if preemptive authentication should be

559

attempted, <tt>false</tt> otherwise.</DL>

560

</DD>

561

</DL>

562

<HR>

563

564

565

isAuthenticationPreemptive</H3>

566

<PRE>

567

public boolean isAuthenticationPreemptive()</PRE>

568

<DL>

569

<DD>Returns <tt>true</tt> if preemptive authentication should be

570

attempted, <tt>false</tt> otherwise.<DD><DL>

571

<DT>Returns:<DD>boolean flag.</DL>

572

</DD>

573

</DL>

574

<HR>

575

576

577

setCookiePolicy</H3>

578

<PRE>

579

public void setCookiePolicy(int policy)</PRE>

580

<DL>

581

<DD>Sets the current <A HREF="../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html"><CODE>cookie policy</CODE></A> for this HTTP

582

state to one of the following supported policies:

583

<A HREF="../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#COMPATIBILITY"><CODE>CookiePolicy.COMPATIBILITY</CODE></A>,

584

<A HREF="../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#NETSCAPE_DRAFT"><CODE>CookiePolicy.NETSCAPE_DRAFT</CODE></A> or

585

<A HREF="../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#RFC2109"><CODE>CookiePolicy.RFC2109</CODE></A>.<DD><DL>

586

<DT>Parameters:<DD><CODE>policy</CODE> - new <A HREF="../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html"><CODE>cookie policy</CODE></A></DL>

587

</DD>

588

</DL>

589

<HR>

590

591

592

setCredentials</H3>

593

<PRE>

594

public void setCredentials(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> realm,

595

<A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A> credentials)</PRE>

596

<DL>

597

<DD>Deprecated. This method does not distinguish between realms with the

598

same name on different hosts.

599

600

601

<DD>Sets the <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> for the given authentication

602

realm. The <code>null</code> realm signifies default credentials, which

603

should be used when no <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> have been explictly

604

supplied for the given challenging realm. Any previous credentials for

605

the given realm will be overwritten.<DD><DL>

606

<DT>Parameters:<DD><CODE>realm</CODE> - the authentication realm<DD><CODE>credentials</CODE> - the authentication credentials for the given realm<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getCredentials(java.lang.String, java.lang.String)"><CODE>getCredentials(String, String)</CODE></A>,

607

608

</DD>

609

</DL>

610

<HR>

611

612

613

setCredentials</H3>

614

<PRE>

615

public void setCredentials(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> realm,

616

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

617

<A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A> credentials)</PRE>

618

<DL>

619

<DD>Sets the <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> for the given authentication

620

realm on the given host. The <code>null</code> realm signifies default

621

credentials for the given host, which should be used when no

622

<A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> have been explictly supplied for the

623

challenging realm. The <code>null</code> host signifies default

624

credentials, which should be used when no <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A>

625

have been explictly supplied for the challenging host. Any previous

626

credentials for the given realm on the given host will be overwritten.<DD><DL>

627

<DT>Parameters:<DD><CODE>realm</CODE> - the authentication realm<DD><CODE>host</CODE> - the host the realm belongs to<DD><CODE>credentials</CODE> - the authentication <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A>

628

for the given realm.<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getCredentials(java.lang.String, java.lang.String)"><CODE>getCredentials(String, String)</CODE></A>,

629

630

</DD>

631

</DL>

632

<HR>

633

634

635

getCredentials</H3>

636

<PRE>

637

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

638

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

639

<DL>

640

<DD>Get the <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> for the given authentication realm on the

641

given host.

642

643

If the realm exists on host, return the coresponding credentials.

644

If the host exists with a <tt>null</tt> realm, return the corresponding

645

credentials.

646

If the realm exists with a <tt>null</tt> host, return the

647

corresponding credentials. If the realm does not exist, return

648

the default Credentials. If there are no default credentials, return

649

650

<DT>Parameters:<DD><CODE>realm</CODE> - the authentication realm<DD><CODE>host</CODE> - the host the realm is on<DT>Returns:<DD>the credentials<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setCredentials(java.lang.String, java.lang.String, org.apache.commons.httpclient.Credentials)"><CODE>setCredentials(String, String, Credentials)</CODE></A></DL>

651

</DD>

652

</DL>

653

<HR>

654

655

656

getCredentials</H3>

657

<PRE>

658

659

<DL>

660

<DD>Deprecated. This method does not distinguish between realms on different

661

servers with the same name. Use <A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getCredentials(java.lang.String, java.lang.String)"><CODE>getCredentials(String, String)</CODE></A>

662

instead.

663

664

<DD>Get the <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> for the given authentication realm.<DD><DL>

665

<DT>Parameters:<DD><CODE>realm</CODE> - the authentication realm<DT>Returns:<DD>the credentials<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setCredentials(java.lang.String, java.lang.String, org.apache.commons.httpclient.Credentials)"><CODE>setCredentials(String, String, Credentials)</CODE></A></DL>

666

</DD>

667

</DL>

668

<HR>

669

670

671

setProxyCredentials</H3>

672

<PRE>

673

public void setProxyCredentials(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> realm,

674

<A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A> credentials)</PRE>

675

<DL>

676

<DD>Deprecated. This method does not differentiate between realms with

677

the same name on different servers. Use

678

679

680

<DD>Sets the <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> for the given proxy authentication

681

realm. The <code>null</code> realm signifies default credentials, which

682

should be used when no <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> have been explictly

683

supplied for the given challenging proxy realm. Any previous credentials for

684

the given realm will be overwritten.<DD><DL>

685

<DT>Parameters:<DD><CODE>realm</CODE> - the authentication realm<DD><CODE>credentials</CODE> - the authentication credentials for the given realm<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getProxyCredentials(java.lang.String)"><CODE>getProxyCredentials(String)</CODE></A>,

686

<A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setCredentials(java.lang.String, org.apache.commons.httpclient.Credentials)"><CODE>setCredentials(String, Credentials)</CODE></A></DL>

687

</DD>

688

</DL>

689

<HR>

690

691

692

setProxyCredentials</H3>

693

<PRE>

694

public void setProxyCredentials(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> realm,

695

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

696

<A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A> credentials)</PRE>

697

<DL>

698

<DD>Sets the <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> for the given proxy authentication

699

realm on the given proxy host. The <code>null</code> proxy realm signifies

700

default credentials for the given proxy host, which should be used when no

701

<A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> have been explictly supplied for the

702

challenging proxy realm. The <code>null</code> proxy host signifies default

703

credentials, which should be used when no <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A>

704

have been explictly supplied for the challenging proxy host. Any previous

705

credentials for the given proxy realm on the given proxy host will be

706

overwritten.<DD><DL>

707

<DT>Parameters:<DD><CODE>realm</CODE> - the authentication realm<DD><CODE>proxyHost</CODE> - the proxy host<DD><CODE>credentials</CODE> - the authentication credentials for the given realm<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getProxyCredentials(java.lang.String)"><CODE>getProxyCredentials(String)</CODE></A>,

708

709

</DD>

710

</DL>

711

<HR>

712

713

714

getProxyCredentials</H3>

715

<PRE>

716

public <A HREF="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</A> getProxyCredentials(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> realm)</PRE>

717

<DL>

718

<DD>Deprecated. This method does not distinguish between realms on different hosts.

719

Use <A HREF="../../../../org/apache/commons/httpclient/HttpState.html#getProxyCredentials(java.lang.String, java.lang.String)"><CODE>getProxyCredentials(String, String)</CODE></A> instead.

720

721

<DD>Get the <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> for the given

722

proxy authentication realm.

723

724

If the realm exists, return the coresponding credentials. If the

725

realm does not exist, return the default Credentials. If there is

726

no default credentials, return <code>null</code>.<DD><DL>

727

<DT>Parameters:<DD><CODE>realm</CODE> - the authentication realm<DT>Returns:<DD>the credentials<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setProxyCredentials(java.lang.String, java.lang.String, org.apache.commons.httpclient.Credentials)"><CODE>setProxyCredentials(String, String, Credentials)</CODE></A></DL>

728

</DD>

729

</DL>

730

<HR>

731

732

733

getProxyCredentials</H3>

734

<PRE>

735

736

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

737

<DL>

738

<DD>Get the <A HREF="../../../../org/apache/commons/httpclient/Credentials.html"><CODE>credentials</CODE></A> for the proxy host with the given

739

authentication realm.

740

741

If the realm exists on host, return the coresponding credentials.

742

If the host exists with a <tt>null</tt> realm, return the corresponding

743

credentials.

744

If the realm exists with a <tt>null</tt> host, return the

745

corresponding credentials. If the realm does not exist, return

746

the default Credentials. If there are no default credentials, return

747

748

<DT>Parameters:<DD><CODE>realm</CODE> - the authentication realm<DD><CODE>proxyHost</CODE> - the proxy host the realm is on<DT>Returns:<DD>the credentials<DT>See Also: <DD><A HREF="../../../../org/apache/commons/httpclient/HttpState.html#setProxyCredentials(java.lang.String, java.lang.String, org.apache.commons.httpclient.Credentials)"><CODE>setProxyCredentials(String, String, Credentials)</CODE></A></DL>

749

</DD>

750

</DL>

751

<HR>

752

753

754

toString</H3>

755

<PRE>

756

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

757

<DL>

758

<DD>Returns a string representation of this HTTP state.<DD><DL>

759

<DT>Overrides:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#toString()">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">Object</A></CODE></DL>

760

</DD>

761

762

<DT>Returns:<DD>The string representation of the HTTP state.<DT>See Also: <DD><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#toString()"><CODE>Object.toString()</CODE></A></DL>

763

</DD>

764

</DL>

765

<HR>

766

767

768

getHttpConnectionManager</H3>

769

<PRE>

770

public <A HREF="../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</A> getHttpConnectionManager()</PRE>

771

<DL>

772

<DD>Deprecated. Connection manager is controlled by the HttpClient class.

773

Use <A HREF="../../../../org/apache/commons/httpclient/HttpClient.html#getHttpConnectionManager()"><CODE>HttpClient.getHttpConnectionManager()</CODE></A> instead.

774

775

<DD>Returns the httpConnectionManager.<DD><DL>

776

<DT>Returns:<DD>HttpConnectionManager<DT>Since: <DD>2.0</DD>

777

</DL>

778

</DD>

779

</DL>

780

<HR>

781

782

783

setHttpConnectionManager</H3>

784

<PRE>

785

public void setHttpConnectionManager(<A HREF="../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</A> httpConnectionManager)</PRE>

786

<DL>

787

<DD>Deprecated. Connection manager is controlled by the HttpClient class.

788

789

790

<DD>Sets the httpConnectionManager.<DD><DL>

791

<DT>Parameters:<DD><CODE>httpConnectionManager</CODE> - The httpConnectionManager to set<DT>Since: <DD>2.0</DD>

792

</DL>

793

</DD>

794

</DL>

795

796

<HR>

797

798

799

800

801

<TR>

802

803

804

805

806

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

807

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

808

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

809

810

811

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

812

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

813

814

</TR>

815

</TABLE>

816

</TD>

817

818

819

</TD>

820

</TR>

821

822

<TR>

823

824

<A HREF="../../../../org/apache/commons/httpclient/HttpParser.html">PREV CLASS</A>

825

<A HREF="../../../../org/apache/commons/httpclient/HttpStatus.html">NEXT CLASS</A></TD>

826

827

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

828

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

829

</TR>

830

<TR>

831

832

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

833

834

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

835

</TR>

836

</TABLE>

837

838

839

<HR>

840

841

</BODY>

842

</HTML>

Older »