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

<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">Cookie</A> cookie)</CODE>

129

130

131

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

132

</TR>

133

134

135

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

136

<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">Cookie</A> cookie)</CODE>

137

138

139

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

140

</TR>

141

142

143

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

144

<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">Cookie</A>[] cookies)</CODE>

145

146

147

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

148

</TR>

149

150

151

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

152

<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">Cookie</A>[] cookies)</CODE>

153

154

155

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

156

</TR>

157

158

159

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

160

<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.1/docs/api/java/lang/String.html">String</A> host,

161

int port,

162

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

163

boolean secure,

164

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

165

166

167

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

168

</TR>

169

170

171

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

172

<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.1/docs/api/java/lang/String.html">String</A> host,

173

int port,

174

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

175

boolean secure,

176

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

177

178

179

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

180

</TR>

181

182

183

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

184

<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.1/docs/api/java/lang/String.html">String</A> host,

185

int port,

186

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

187

boolean secure,

188

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

189

190

191

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

192

</TR>

193

194

195

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

196

<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.1/docs/api/java/lang/String.html">String</A> host,

197

int port,

198

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

199

boolean secure,

200

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

201

202

203

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

204

</TR>

205

206

207

208

<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">NameValuePair</A> attribute,

209

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

210

211

212

          Parse the cookie attribute and update the corresponsing Cookie

213

properties.</TD>

214

</TR>

215

216

217

218

<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.1/docs/api/java/lang/String.html">String</A> host,

219

int port,

220

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

221

boolean secure,

222

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

223

224

225

          Validate the cookie according to validation rules defined by the

226

cookie specification.</TD>

227

</TR>

228

</TABLE>

229

230

231

232

233

234

235

236

237

238

Field Detail</TD>

239

</TR>

240

</TABLE>

241

242

243

PATH_DELIM</H3>

244

<PRE>

245

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

246

<DL>

247

<DD>Path delimiter</DL>

248

<HR>

249

250

251

PATH_DELIM_CHAR</H3>

252

<PRE>

253

public static final char PATH_DELIM_CHAR</PRE>

254

<DL>

255

<DD>Path delimiting charachter</DL>

256

257

258

259

260

261

262

263

264

265

266

Method Detail</TD>

267

</TR>

268

</TABLE>

269

270

271

parse</H3>

272

<PRE>

273

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

274

int port,

275

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

276

boolean secure,

277

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

278

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

279

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

280

<DL>

281

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

282

<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

283

was received over secure conection<DD><CODE>header</CODE> - the <tt>Set-Cookie</tt> received from the server<DT>Returns:<DD>an array of <tt>Cookie</tt>s parsed from the Set-Cookie value<DT>Throws:<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</A></CODE> - if an exception occurs during parsing<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if an input parameter is illegal</DL>

284

</DD>

285

</DL>

286

<HR>

287

288

289

parse</H3>

290

<PRE>

291

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

292

int port,

293

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

294

boolean secure,

295

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

296

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

297

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

298

<DL>

299

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

300

301

was received over secure conection<DD><CODE>header</CODE> - the <tt>Set-Cookie</tt> received from the server<DT>Returns:<DD>an array of <tt>Cookie</tt>s parsed from the header<DT>Throws:<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</A></CODE> - if an exception occurs during parsing<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if an input parameter is illegal</DL>

302

</DD>

303

</DL>

304

<HR>

305

306

307

parseAttribute</H3>

308

<PRE>

309

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

310

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

311

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

312

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

313

<DL>

314

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

315

properties.<DD><DL>

316

<DT>Parameters:<DD><CODE>attribute</CODE> - cookie attribute from the <tt>Set-Cookie</tt><DD><CODE>cookie</CODE> - the to be updated<DT>Throws:<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</A></CODE> - if an exception occurs during parsing<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if an input parameter is illegal</DL>

317

</DD>

318

</DL>

319

<HR>

320

321

322

validate</H3>

323

<PRE>

324

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

325

int port,

326

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

327

boolean secure,

328

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

329

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

330

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

331

<DL>

332

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

333

cookie specification.<DD><DL>

334

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

335

using a secure connection<DD><CODE>cookie</CODE> - the Cookie to validate<DT>Throws:<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</A></CODE> - if the cookie is invalid<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if an input parameter is illegal</DL>

336

</DD>

337

</DL>

338

<HR>

339

340

341

match</H3>

342

<PRE>

343

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

344

int port,

345

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

346

boolean secure,

347

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

348

<DL>

349

<DD>Determines if a Cookie matches a location.<DD><DL>

350

<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<DT>Returns:<DD><tt>true</tt> if the cookie should be submitted with a request

351

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

352

</DD>

353

</DL>

354

<HR>

355

356

357

match</H3>

358

<PRE>

359

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

360

int port,

361

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

362

boolean secure,

363

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

364

<DL>

365

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

366

<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

367

(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<DT>Returns:<DD><tt>true</tt> if the cookie should be submitted with a request

368

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

369

</DD>

370

</DL>

371

<HR>

372

373

374

formatCookie</H3>

375

<PRE>

376

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

377

<DL>

378

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

379

<DT>Parameters:<DD><CODE>cookie</CODE> - the cookie to be formatted as string<DT>Returns:<DD>a string suitable for sending in a <tt>"Cookie"</tt> header.</DL>

380

</DD>

381

</DL>

382

<HR>

383

384

385

formatCookies</H3>

386

<PRE>

387

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

388

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

389

<DL>

390

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

391

<DT>Parameters:<DD><CODE>cookies</CODE> - the Cookies to be formatted<DT>Returns:<DD>a string suitable for sending in a Cookie header.<DT>Throws:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if an input parameter is illegal</DL>

392

</DD>

393

</DL>

394

<HR>

395

396

397

formatCookieHeader</H3>

398

<PRE>

399

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

400

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

401

<DL>

402

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

403

<DT>Parameters:<DD><CODE>cookies</CODE> - the Cookies format into a Cookie header<DT>Returns:<DD>a Header for the given Cookies.<DT>Throws:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if an input parameter is illegal</DL>

404

</DD>

405

</DL>

406

<HR>

407

408

409

formatCookieHeader</H3>

410

<PRE>

411

public <A HREF="../../../../../org/apache/commons/httpclient/Header.html">Header</A> formatCookieHeader(<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</A> cookie)

412

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

413

<DL>

414

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

415

<DT>Parameters:<DD><CODE>cookie</CODE> - the Cookie format as a <tt>Cookie</tt> header<DT>Returns:<DD>a Cookie header.<DT>Throws:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></CODE> - if an input parameter is illegal</DL>

416

</DD>

417

</DL>

418

419

<HR>

420

421

422

423

424

<TR>

425

426

427

428

429

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

430

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

431

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

432

433

434

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

435

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

436

437

</TR>

438

</TABLE>

439

</TD>

440

441

442

</TD>

443

</TR>

444

445

<TR>

446

447

 PREV CLASS 

448

NEXT CLASS</TD>

449

450

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

451

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

452

</TR>

453

<TR>

454

455

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

456

457

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

458

</TR>

459

</TABLE>

460

461

462

<HR>

463

464

</BODY>

465

</HTML>

Older »