~testplan-team/testplan/source-collection

<A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.html" title="class in org.apache.commons.httpclient.cookie">NEXT CLASS</A></TD>

<A HREF="../../../../../index.html?org/apache/commons/httpclient/cookie/CookieSpec.html" target="_top">FRAMES</A>

<A HREF="CookieSpec.html" target="_top">NO FRAMES</A>

<!--

if(window==top) {

document.writeln('<A HREF="../../../../../allclasses-noframe.html">All Classes</A>');

}

//-->

</SCRIPT>

<A HREF="../../../../../allclasses-noframe.html">All Classes</A>

</NOSCRIPT>

</TD>

</TR>

<TR>

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

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

</TR>

</TABLE>

<HR>

<H2>

org.apache.commons.httpclient.cookie

Interface CookieSpec</H2>

<DL>

<DT>All Known Implementing Classes: <DD><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.html" title="class in org.apache.commons.httpclient.cookie">CookieSpecBase</A>, <A HREF="../../../../../org/apache/commons/httpclient/cookie/IgnoreCookiesSpec.html" title="class in org.apache.commons.httpclient.cookie">IgnoreCookiesSpec</A>, <A HREF="../../../../../org/apache/commons/httpclient/cookie/NetscapeDraftSpec.html" title="class in org.apache.commons.httpclient.cookie">NetscapeDraftSpec</A>, <A HREF="../../../../../org/apache/commons/httpclient/cookie/RFC2109Spec.html" title="class in org.apache.commons.httpclient.cookie">RFC2109Spec</A>, <A HREF="../../../../../org/apache/commons/httpclient/cookie/RFC2965Spec.html" title="class in org.apache.commons.httpclient.cookie">RFC2965Spec</A></DD>

</DL>

<HR>

<DL>

<DT><PRE>public interface CookieSpec</DL>

</PRE>

100

101

Defines the cookie management specification.

102

Cookie management specification must define

103

<ul>

104

<li> rules of parsing "Set-Cookie" header

105

<li> rules of validation of parsed cookies

106

<li> formatting of "Cookie" header

107

</ul>

108

for a given host, port and path of origin

109

110

111

112

<DL>

113

<DT>Since:</DT>

114

115

<DT>Author:</DT>

116

<DD><a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>, <a href="mailto:jsdever@apache.org">Jeff Dever</a></DD>

117

</DL>

118

<HR>

119

120

121

122

123

124

125

126

127

Field Summary</TH>

128

</TR>

129

130

131

<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></TD>

132

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

133

134

135

Path delimiter</TD>

136

</TR>

137

138

139

<CODE>static char</CODE></TD>

140

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

141

142

143

Path delimiting charachter</TD>

144

</TR>

145

</TABLE>

146

147

148

149

150

151

152

153

Method Summary</TH>

154

</TR>

155

156

157

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

158

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#domainMatch(java.lang.String, java.lang.String)">domainMatch</A>(<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> host,

159

<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> domain)</CODE>

160

161

162

Performs domain-match as defined by the cookie specification.</TD>

163

</TR>

164

165

166

<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></TD>

167

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#formatCookie(org.apache.commons.httpclient.Cookie)">formatCookie</A>(<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A> cookie)</CODE>

168

169

170

Create a <tt>"Cookie"</tt> header value for an array of cookies.</TD>

171

</TR>

172

173

174

<CODE> <A HREF="../../../../../org/apache/commons/httpclient/Header.html" title="class in org.apache.commons.httpclient">Header</A></CODE></TD>

175

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#formatCookieHeader(org.apache.commons.httpclient.Cookie)">formatCookieHeader</A>(<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A> cookie)</CODE>

176

177

178

Create a <tt>"Cookie"</tt> Header for single Cookie.</TD>

179

</TR>

180

181

182

<CODE> <A HREF="../../../../../org/apache/commons/httpclient/Header.html" title="class in org.apache.commons.httpclient">Header</A></CODE></TD>

183

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#formatCookieHeader(org.apache.commons.httpclient.Cookie[])">formatCookieHeader</A>(<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A>[] cookies)</CODE>

184

185

186

Create a <tt>"Cookie"</tt> Header for an array of Cookies.</TD>

187

</TR>

188

189

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></TD>

191

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#formatCookies(org.apache.commons.httpclient.Cookie[])">formatCookies</A>(<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A>[] cookies)</CODE>

192

193

194

Create a <tt>"Cookie"</tt> header value for an array of cookies.</TD>

195

</TR>

196

197

198

<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></TD>

199

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

200

201

202

Returns the <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util"><CODE>Collection</CODE></A> of date patterns used for parsing.</TD>

203

</TR>

204

205

206

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

207

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#match(java.lang.String, int, java.lang.String, boolean, org.apache.commons.httpclient.Cookie)">match</A>(<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> host,

208

int port,

209

<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> path,

210

boolean secure,

211

<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A> cookie)</CODE>

212

213

214

Determines if a Cookie matches a location.</TD>

215

</TR>

216

217

218

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

219

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#match(java.lang.String, int, java.lang.String, boolean, org.apache.commons.httpclient.Cookie[])">match</A>(<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> host,

220

int port,

221

<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> path,

222

boolean secure,

223

<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A>[] cookies)</CODE>

224

225

226

Determines which of an array of Cookies matches a location.</TD>

227

</TR>

228

229

230

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

231

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#parse(java.lang.String, int, java.lang.String, boolean, org.apache.commons.httpclient.Header)">parse</A>(<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> host,

232

int port,

233

<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> path,

234

boolean secure,

235

<A HREF="../../../../../org/apache/commons/httpclient/Header.html" title="class in org.apache.commons.httpclient">Header</A> header)</CODE>

236

237

238

Parse the <tt>"Set-Cookie"</tt> Header into an array of Cookies.</TD>

239

</TR>

240

241

242

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

243

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#parse(java.lang.String, int, java.lang.String, boolean, java.lang.String)">parse</A>(<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> host,

244

int port,

245

<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> path,

246

boolean secure,

247

<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> header)</CODE>

248

249

250

Parse the <tt>"Set-Cookie"</tt> header value into Cookie array.</TD>

251

</TR>

252

253

254

255

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#parseAttribute(org.apache.commons.httpclient.NameValuePair, org.apache.commons.httpclient.Cookie)">parseAttribute</A>(<A HREF="../../../../../org/apache/commons/httpclient/NameValuePair.html" title="class in org.apache.commons.httpclient">NameValuePair</A> attribute,

256

<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A> cookie)</CODE>

257

258

259

          Parse the cookie attribute and update the corresponsing Cookie

260

properties.</TD>

261

</TR>

262

263

264

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

265

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#pathMatch(java.lang.String, java.lang.String)">pathMatch</A>(<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> path,

266

<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> topmostPath)</CODE>

267

268

269

Performs path-match as defined by the cookie specification.</TD>

270

</TR>

271

272

273

274

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#setValidDateFormats(java.util.Collection)">setValidDateFormats</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> datepatterns)</CODE>

275

276

277

Sets the <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util"><CODE>Collection</CODE></A> of date patterns used for parsing.</TD>

278

</TR>

279

280

281

282

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#validate(java.lang.String, int, java.lang.String, boolean, org.apache.commons.httpclient.Cookie)">validate</A>(<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> host,

283

int port,

284

<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> path,

285

boolean secure,

286

<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A> cookie)</CODE>

287

288

289

          Validate the cookie according to validation rules defined by the

290

cookie specification.</TD>

291

</TR>

292

</TABLE>

293

294

295

296

297

298

299

300

301

302

Field Detail</TH>

303

</TR>

304

</TABLE>

305

306

307

PATH_DELIM</H3>

308

<PRE>

309

static final <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> PATH_DELIM</PRE>

310

<DL>

311

<DD>Path delimiter

312

313

<DL>

314

<DT>See Also:<DD><A HREF="../../../../../constant-values.html#org.apache.commons.httpclient.cookie.CookieSpec.PATH_DELIM">Constant Field Values</A></DL>

315

</DL>

316

<HR>

317

318

319

PATH_DELIM_CHAR</H3>

320

<PRE>

321

static final char PATH_DELIM_CHAR</PRE>

322

<DL>

323

<DD>Path delimiting charachter

324

325

<DL>

326

</DL>

327

</DL>

328

329

330

331

332

333

334

335

Method Detail</TH>

336

</TR>

337

</TABLE>

338

339

340

parse</H3>

341

<PRE>

342

<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A>[] parse(<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> host,

343

int port,

344

<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> path,

345

boolean secure,

346

<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> header)

347

throws <A HREF="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html" title="class in org.apache.commons.httpclient.cookie">MalformedCookieException</A>,

348

<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>

349

<DL>

350

<DD>Parse the <tt>"Set-Cookie"</tt> header value into Cookie array.

351

352

This method will not perform the validation of the resultant

353

<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient"><CODE>Cookie</CODE></A>s

354

355

356

<DT>Parameters:<DD><CODE>host</CODE> - the host which sent the <tt>Set-Cookie</tt> header<DD><CODE>port</CODE> - the port which sent the <tt>Set-Cookie</tt> header<DD><CODE>path</CODE> - the path which sent the <tt>Set-Cookie</tt> header<DD><CODE>secure</CODE> - <tt>true</tt> when the <tt>Set-Cookie</tt> header

357

was received over secure conection<DD><CODE>header</CODE> - the <tt>Set-Cookie</tt> received from the server

358

<DT>Returns:<DD>an array of <tt>Cookie</tt>s parsed from the Set-Cookie value

359

<DT>Throws:

360

<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html" title="class in org.apache.commons.httpclient.cookie">MalformedCookieException</A></CODE> - if an exception occurs during parsing

361

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an input parameter is illegal<DT>See Also:<DD><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#validate(java.lang.String, int, java.lang.String, boolean, org.apache.commons.httpclient.Cookie)"><CODE>validate(String, int, String, boolean, Cookie)</CODE></A></DL>

362

</DD>

363

</DL>

364

<HR>

365

366

367

parse</H3>

368

<PRE>

369

370

int port,

371

<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> path,

372

boolean secure,

373

<A HREF="../../../../../org/apache/commons/httpclient/Header.html" title="class in org.apache.commons.httpclient">Header</A> header)

374

throws <A HREF="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html" title="class in org.apache.commons.httpclient.cookie">MalformedCookieException</A>,

375

<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>

376

<DL>

377

<DD>Parse the <tt>"Set-Cookie"</tt> Header into an array of Cookies.

378

379

This method will not perform the validation of the resultant

380

<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient"><CODE>Cookie</CODE></A>s

381

382

383

384

was received over secure conection<DD><CODE>header</CODE> - the <tt>Set-Cookie</tt> received from the server

385

<DT>Returns:<DD>an array of <tt>Cookie</tt>s parsed from the header

386

<DT>Throws:

387

388

389

</DD>

390

</DL>

391

<HR>

392

393

394

parseAttribute</H3>

395

<PRE>

396

void parseAttribute(<A HREF="../../../../../org/apache/commons/httpclient/NameValuePair.html" title="class in org.apache.commons.httpclient">NameValuePair</A> attribute,

397

<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A> cookie)

398

throws <A HREF="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html" title="class in org.apache.commons.httpclient.cookie">MalformedCookieException</A>,

399

<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>

400

<DL>

401

<DD>Parse the cookie attribute and update the corresponsing Cookie

402

properties.

403

404

405

<DT>Parameters:<DD><CODE>attribute</CODE> - cookie attribute from the <tt>Set-Cookie</tt><DD><CODE>cookie</CODE> - the to be updated

406

<DT>Throws:

407

408

409

</DD>

410

</DL>

411

<HR>

412

413

414

validate</H3>

415

<PRE>

416

void validate(<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> host,

417

int port,

418

<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> path,

419

boolean secure,

420

<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A> cookie)

421

throws <A HREF="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html" title="class in org.apache.commons.httpclient.cookie">MalformedCookieException</A>,

422

<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>

423

<DL>

424

<DD>Validate the cookie according to validation rules defined by the

425

cookie specification.

426

427

428

<DT>Parameters:<DD><CODE>host</CODE> - the host from which the <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient"><CODE>Cookie</CODE></A> was received<DD><CODE>port</CODE> - the port from which the <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient"><CODE>Cookie</CODE></A> was received<DD><CODE>path</CODE> - the path from which the <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient"><CODE>Cookie</CODE></A> was received<DD><CODE>secure</CODE> - <tt>true</tt> when the <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient"><CODE>Cookie</CODE></A> was received

429

using a secure connection<DD><CODE>cookie</CODE> - the Cookie to validate

430

<DT>Throws:

431

432

433

</DD>

434

</DL>

435

<HR>

436

437

438

setValidDateFormats</H3>

439

<PRE>

440

void setValidDateFormats(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> datepatterns)</PRE>

441

<DL>

442

<DD>Sets the <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util"><CODE>Collection</CODE></A> of date patterns used for parsing. The String patterns must be

443

compatible with <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html" title="class or interface in java.text"><CODE>SimpleDateFormat</CODE></A>.

444

445

446

<DT>Parameters:<DD><CODE>datepatterns</CODE> - collection of date patterns</DL>

447

</DD>

448

</DL>

449

<HR>

450

451

452

getValidDateFormats</H3>

453

<PRE>

454

<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> getValidDateFormats()</PRE>

455

<DL>

456

<DD>Returns the <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util"><CODE>Collection</CODE></A> of date patterns used for parsing. The String patterns are compatible

457

with the <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html" title="class or interface in java.text"><CODE>SimpleDateFormat</CODE></A>.

458

459

460

461

<DT>Returns:<DD>collection of date patterns</DL>

462

</DD>

463

</DL>

464

<HR>

465

466

467

match</H3>

468

<PRE>

469

boolean match(<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> host,

470

int port,

471

<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> path,

472

boolean secure,

473

<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A> cookie)</PRE>

474

<DL>

475

<DD>Determines if a Cookie matches a location.

476

477

478

<DT>Parameters:<DD><CODE>host</CODE> - the host to which the request is being submitted<DD><CODE>port</CODE> - the port to which the request is being submitted<DD><CODE>path</CODE> - the path to which the request is being submitted<DD><CODE>secure</CODE> - <tt>true</tt> if the request is using a secure connection<DD><CODE>cookie</CODE> - the Cookie to be matched

479

<DT>Returns:<DD><tt>true</tt> if the cookie should be submitted with a request

480

with given attributes, <tt>false</tt> otherwise.</DL>

481

</DD>

482

</DL>

483

<HR>

484

485

486

match</H3>

487

<PRE>

488

<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A>[] match(<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> host,

489

int port,

490

<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> path,

491

boolean secure,

492

<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A>[] cookies)</PRE>

493

<DL>

494

<DD>Determines which of an array of Cookies matches a location.

495

496

497

<DT>Parameters:<DD><CODE>host</CODE> - the host to which the request is being submitted<DD><CODE>port</CODE> - the port to which the request is being submitted

498

(currenlty ignored)<DD><CODE>path</CODE> - the path to which the request is being submitted<DD><CODE>secure</CODE> - <tt>true</tt> if the request is using a secure protocol<DD><CODE>cookies</CODE> - an array of <tt>Cookie</tt>s to be matched

499

<DT>Returns:<DD><tt>true</tt> if the cookie should be submitted with a request

500

with given attributes, <tt>false</tt> otherwise.</DL>

501

</DD>

502

</DL>

503

<HR>

504

505

506

domainMatch</H3>

507

<PRE>

508

boolean domainMatch(<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> host,

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> domain)</PRE>

510

<DL>

511

<DD>Performs domain-match as defined by the cookie specification.

512

513

514

<DT>Parameters:<DD><CODE>host</CODE> - The target host.<DD><CODE>domain</CODE> - The cookie domain attribute.

515

<DT>Returns:<DD>true if the specified host matches the given domain.<DT>Since:</DT>

516

517

</DL>

518

</DD>

519

</DL>

520

<HR>

521

522

523

pathMatch</H3>

524

<PRE>

525

boolean pathMatch(<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> path,

526

<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> topmostPath)</PRE>

527

<DL>

528

<DD>Performs path-match as defined by the cookie specification.

529

530

531

<DT>Parameters:<DD><CODE>path</CODE> - The target path.<DD><CODE>topmostPath</CODE> - The cookie path attribute.

532

<DT>Returns:<DD>true if the paths match<DT>Since:</DT>

533

534

</DL>

535

</DD>

536

</DL>

537

<HR>

538

539

540

formatCookie</H3>

541

<PRE>

542

<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> formatCookie(<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A> cookie)</PRE>

543

<DL>

544

<DD>Create a <tt>"Cookie"</tt> header value for an array of cookies.

545

546

547

<DT>Parameters:<DD><CODE>cookie</CODE> - the cookie to be formatted as string

548

<DT>Returns:<DD>a string suitable for sending in a <tt>"Cookie"</tt> header.</DL>

549

</DD>

550

</DL>

551

<HR>

552

553

554

formatCookies</H3>

555

<PRE>

556

<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> formatCookies(<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A>[] cookies)

557

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>

558

<DL>

559

<DD>Create a <tt>"Cookie"</tt> header value for an array of cookies.

560

561

562

<DT>Parameters:<DD><CODE>cookies</CODE> - the Cookies to be formatted

563

<DT>Returns:<DD>a string suitable for sending in a Cookie header.

564

<DT>Throws:

565

566

</DD>

567

</DL>

568

<HR>

569

570

571

formatCookieHeader</H3>

572

<PRE>

573

<A HREF="../../../../../org/apache/commons/httpclient/Header.html" title="class in org.apache.commons.httpclient">Header</A> formatCookieHeader(<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html" title="class in org.apache.commons.httpclient">Cookie</A>[] cookies)

574

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>

575

<DL>

576

<DD>Create a <tt>"Cookie"</tt> Header for an array of Cookies.

577

578

579

<DT>Parameters:<DD><CODE>cookies</CODE> - the Cookies format into a Cookie header

580

<DT>Returns:<DD>a Header for the given Cookies.

581

<DT>Throws:

582

583

</DD>

584

</DL>

585

<HR>

586

587

588

formatCookieHeader</H3>

589

<PRE>

590

591

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>

592

<DL>

593

<DD>Create a <tt>"Cookie"</tt> Header for single Cookie.

594

595

596

<DT>Parameters:<DD><CODE>cookie</CODE> - the Cookie format as a <tt>Cookie</tt> header

597

<DT>Returns:<DD>a Cookie header.

598

<DT>Throws:

599

600

</DD>

601

</DL>

602

603

<HR>

604

605

606

607

608

609

610

<TR>

611

612

613

614

615

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

616

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

617

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

618

619

620

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

621

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

622

623

</TR>

624

</TABLE>

625

</TD>

626

627

628

</TD>

629

</TR>

630

631

<TR>

632

633

<A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html" title="class in org.apache.commons.httpclient.cookie">PREV CLASS</A>

634

<A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.html" title="class in org.apache.commons.httpclient.cookie">NEXT CLASS</A></TD>

635

636

<A HREF="../../../../../index.html?org/apache/commons/httpclient/cookie/CookieSpec.html" target="_top">FRAMES</A>

637

<A HREF="CookieSpec.html" target="_top">NO FRAMES</A>

638

639

<!--

640

if(window==top) {

641

document.writeln('<A HREF="../../../../../allclasses-noframe.html">All Classes</A>');

642

}

643

//-->

644

</SCRIPT>

645

646

<A HREF="../../../../../allclasses-noframe.html">All Classes</A>

647

</NOSCRIPT>

648

649

650

</TD>

651

</TR>

652

<TR>

653

654

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

655

656

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

657

</TR>

658

</TABLE>

659

660

661

662

<HR>

663

664

</BODY>

665

</HTML>

Older »