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

<DT>Direct Known Subclasses: <DD><A HREF="../../../../../org/apache/commons/httpclient/cookie/NetscapeDraftSpec.html">NetscapeDraftSpec</A>, <A HREF="../../../../../org/apache/commons/httpclient/cookie/RFC2109Spec.html">RFC2109Spec</A></DD>

</DL>

<HR>

<DL>

<DT>public class CookieSpecBase<DT>extends <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">Object</A><DT>implements <A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></DL>

Cookie management functions shared by all specification.

<DL>

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

<DT>Author: <DD>B.C. Holmes, <a href="mailto:jericho@thinkfree.com">Park, Sung-Gu</a>, <a href="mailto:dsale@us.britannica.com">Doug Sale</a>, Rod Waldhoff, dIon Gillard, Sean C. Sullivan, <a href="mailto:JEvans@Cyveillance.com">John Evans</a>, Marc A. Saegesser, <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>, <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a></DD>

</DL>

<HR>

Field Summary</TD>

</TR>

<CODE>protected static <A HREF="http://jakarta.apache.org/commons/logging/apidocs/org/apache/commons/logging/Log.html">Log</A></CODE></TD>

100

101

102

103

Log object</TD>

104

</TR>

105

</TABLE>

106

107

108

109

<TD>Fields inherited from interface org.apache.commons.httpclient.cookie.<A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></TD>

110

</TR>

111

112

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

113

</TR>

114

</TABLE>

115

116

117

118

119

120

121

122

Constructor Summary</TD>

123

</TR>

124

125

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

126

127

128

Default constructor</TD>

129

</TR>

130

</TABLE>

131

132

133

134

135

136

137

138

Method Summary</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/cookie/CookieSpecBase.html#formatCookie(org.apache.commons.httpclient.Cookie)">formatCookie</A>(<A HREF="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</A> cookie)</CODE>

144

145

146

Return a string suitable for sending in a <tt>"Cookie"</tt> header</TD>

147

</TR>

148

149

150

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

151

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

152

153

154

Create a <tt>"Cookie"</tt> <A HREF="../../../../../org/apache/commons/httpclient/Header.html"><CODE>Header</CODE></A> containing the <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>.</TD>

155

</TR>

156

157

158

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

159

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

160

161

162

Create a <tt>"Cookie"</tt> <A HREF="../../../../../org/apache/commons/httpclient/Header.html"><CODE>Header</CODE></A> containing all <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>s

163

in cookies.</TD>

164

</TR>

165

166

167

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

168

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

169

170

171

Create a <tt>"Cookie"</tt> header value containing all <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>s in

172

cookies suitable for sending in a <tt>"Cookie"</tt> header</TD>

173

</TR>

174

175

176

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

177

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.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,

178

int port,

179

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

180

boolean secure,

181

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

182

183

184

Return <tt>true</tt> if the cookie should be submitted with a request

185

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

186

</TR>

187

188

189

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

190

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.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,

191

int port,

192

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

193

boolean secure,

194

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

195

196

197

Return an array of <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>s that should be submitted with a

198

request with given attributes, <tt>false</tt> otherwise.</TD>

199

</TR>

200

201

202

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

203

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.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,

204

int port,

205

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

206

boolean secure,

207

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

208

209

210

Parse the <tt>"Set-Cookie"</tt> <A HREF="../../../../../org/apache/commons/httpclient/Header.html"><CODE>Header</CODE></A> into an array of <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>s.</TD>

211

</TR>

212

213

214

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

215

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.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,

216

int port,

217

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

218

boolean secure,

219

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

220

221

222

Parses the Set-Cookie value into an array of <tt>Cookie</tt>s.</TD>

223

</TR>

224

225

226

227

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.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,

228

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

229

230

231

Parse the cookie attribute and update the corresponsing <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>

232

properties.</TD>

233

</TR>

234

235

236

237

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.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,

238

int port,

239

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

240

boolean secure,

241

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

242

243

244

Performs most common <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A> validation</TD>

245

</TR>

246

</TABLE>

247

248

249

250

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

251

</TR>

252

253

<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#toString()">toString</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>

254

</TR>

255

</TABLE>

256

257

258

259

260

261

262

263

264

265

Field Detail</TD>

266

</TR>

267

</TABLE>

268

269

270

LOG</H3>

271

<PRE>

272

protected static final <A HREF="http://jakarta.apache.org/commons/logging/apidocs/org/apache/commons/logging/Log.html">Log</A> LOG</PRE>

273

<DL>

274

<DD>Log object</DL>

275

276

277

278

279

280

281

282

Constructor Detail</TD>

283

</TR>

284

</TABLE>

285

286

287

CookieSpecBase</H3>

288

<PRE>

289

public CookieSpecBase()</PRE>

290

<DL>

291

<DD>Default constructor</DL>

292

293

294

295

296

297

298

299

Method Detail</TD>

300

</TR>

301

</TABLE>

302

303

304

parse</H3>

305

<PRE>

306

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,

307

int port,

308

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

309

boolean secure,

310

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

311

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

312

<DL>

313

<DD>Parses the Set-Cookie value into an array of <tt>Cookie</tt>s.

314

315

The syntax for the Set-Cookie response header is:

316

317

<PRE>

318

set-cookie = "Set-Cookie:" cookies

319

cookies = 1#cookie

320

cookie = NAME "=" VALUE * (";" cookie-av)

321

NAME = attr

322

VALUE = value

323

cookie-av = "Comment" "=" value

324

| "Domain" "=" value

325

| "Max-Age" "=" value

326

| "Path" "=" value

327

| "Secure"

328

| "Version" "=" 1*DIGIT

329

</PRE><DD><DL>

330

<DT>Specified by: <DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#parse(java.lang.String, int, java.lang.String, boolean, java.lang.String)">parse</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></DL>

331

</DD>

332

333

<DT>Parameters:<DD><CODE>host</CODE> - the host from which the <tt>Set-Cookie</tt> value was

334

received<DD><CODE>port</CODE> - the port from which the <tt>Set-Cookie</tt> value was

335

received<DD><CODE>path</CODE> - the path from which the <tt>Set-Cookie</tt> value was

336

received<DD><CODE>secure</CODE> - <tt>true</tt> when the <tt>Set-Cookie</tt> value was

337

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

338

</DD>

339

</DL>

340

<HR>

341

342

343

parse</H3>

344

<PRE>

345

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,

346

int port,

347

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

348

boolean secure,

349

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

350

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

351

<DL>

352

<DD>Parse the <tt>"Set-Cookie"</tt> <A HREF="../../../../../org/apache/commons/httpclient/Header.html"><CODE>Header</CODE></A> into an array of <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>s.

353

354

The syntax for the Set-Cookie response header is:

355

356

<PRE>

357

set-cookie = "Set-Cookie:" cookies

358

cookies = 1#cookie

359

cookie = NAME "=" VALUE * (";" cookie-av)

360

NAME = attr

361

VALUE = value

362

cookie-av = "Comment" "=" value

363

| "Domain" "=" value

364

| "Max-Age" "=" value

365

| "Path" "=" value

366

| "Secure"

367

| "Version" "=" 1*DIGIT

368

</PRE><DD><DL>

369

<DT>Specified by: <DD><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></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></DL>

370

</DD>

371

372

<DT>Parameters:<DD><CODE>host</CODE> - the host from which the <tt>Set-Cookie</tt> header was

373

received<DD><CODE>port</CODE> - the port from which the <tt>Set-Cookie</tt> header was

374

received<DD><CODE>path</CODE> - the path from which the <tt>Set-Cookie</tt> header was

375

received<DD><CODE>secure</CODE> - <tt>true</tt> when the <tt>Set-Cookie</tt> header was

376

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 <tt>"Set-Cookie"

377

</tt> header<DT>Throws:<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</A></CODE> - if an exception occurs during parsing</DL>

378

</DD>

379

</DL>

380

<HR>

381

382

383

parseAttribute</H3>

384

<PRE>

385

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

386

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

387

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

388

<DL>

389

<DD>Parse the cookie attribute and update the corresponsing <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>

390

properties.<DD><DL>

391

<DT>Specified by: <DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#parseAttribute(org.apache.commons.httpclient.NameValuePair, org.apache.commons.httpclient.Cookie)">parseAttribute</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></DL>

392

</DD>

393

394

<DT>Parameters:<DD><CODE>attribute</CODE> - <A HREF="../../../../../org/apache/commons/httpclient/HeaderElement.html"><CODE>HeaderElement</CODE></A> cookie attribute from the

395

<tt>Set- Cookie</tt><DD><CODE>cookie</CODE> - <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A> 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</DL>

396

</DD>

397

</DL>

398

<HR>

399

400

401

validate</H3>

402

<PRE>

403

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

404

int port,

405

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

406

boolean secure,

407

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

408

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

409

<DL>

410

<DD>Performs most common <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A> validation<DD><DL>

411

<DT>Specified by: <DD><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></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></DL>

412

</DD>

413

414

<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 using a

415

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 an exception occurs during

416

validation</DL>

417

</DD>

418

</DL>

419

<HR>

420

421

422

match</H3>

423

<PRE>

424

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

425

int port,

426

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

427

boolean secure,

428

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

429

<DL>

430

<DD>Return <tt>true</tt> if the cookie should be submitted with a request

431

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

432

<DT>Specified by: <DD><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></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></DL>

433

</DD>

434

435

<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 (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 connection<DD><CODE>cookie</CODE> - <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A> to be matched<DT>Returns:<DD>true if the cookie matches the criterium</DL>

436

</DD>

437

</DL>

438

<HR>

439

440

441

match</H3>

442

<PRE>

443

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,

444

int port,

445

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

446

boolean secure,

447

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

448

<DL>

449

<DD>Return an array of <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>s that should be submitted with a

450

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

451

<DT>Specified by: <DD><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></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></DL>

452

</DD>

453

454

<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 (currently

455

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>an array of <tt>Cookie</tt>s matching the criterium</DL>

456

</DD>

457

</DL>

458

<HR>

459

460

461

formatCookie</H3>

462

<PRE>

463

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>

464

<DL>

465

<DD>Return a string suitable for sending in a <tt>"Cookie"</tt> header<DD><DL>

466

<DT>Specified by: <DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#formatCookie(org.apache.commons.httpclient.Cookie)">formatCookie</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></DL>

467

</DD>

468

469

<DT>Parameters:<DD><CODE>cookie</CODE> - a <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A> to be formatted as string<DT>Returns:<DD>a string suitable for sending in a <tt>"Cookie"</tt> header.</DL>

470

</DD>

471

</DL>

472

<HR>

473

474

475

formatCookies</H3>

476

<PRE>

477

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)

478

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

479

<DL>

480

<DD>Create a <tt>"Cookie"</tt> header value containing all <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>s in

481

cookies suitable for sending in a <tt>"Cookie"</tt> header<DD><DL>

482

<DT>Specified by: <DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#formatCookies(org.apache.commons.httpclient.Cookie[])">formatCookies</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></DL>

483

</DD>

484

485

<DT>Parameters:<DD><CODE>cookies</CODE> - an array of <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>s 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>

486

</DD>

487

</DL>

488

<HR>

489

490

491

formatCookieHeader</H3>

492

<PRE>

493

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

494

<DL>

495

<DD>Create a <tt>"Cookie"</tt> <A HREF="../../../../../org/apache/commons/httpclient/Header.html"><CODE>Header</CODE></A> containing all <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>s

496

in cookies.<DD><DL>

497

<DT>Specified by: <DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#formatCookieHeader(org.apache.commons.httpclient.Cookie[])">formatCookieHeader</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></DL>

498

</DD>

499

500

<DT>Parameters:<DD><CODE>cookies</CODE> - an array of <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>s to be formatted as a <tt>"

501

Cookie"</tt> header<DT>Returns:<DD>a <tt>"Cookie"</tt> <A HREF="../../../../../org/apache/commons/httpclient/Header.html"><CODE>Header</CODE></A>.</DL>

502

</DD>

503

</DL>

504

<HR>

505

506

507

formatCookieHeader</H3>

508

<PRE>

509

510

<DL>

511

<DD>Create a <tt>"Cookie"</tt> <A HREF="../../../../../org/apache/commons/httpclient/Header.html"><CODE>Header</CODE></A> containing the <A HREF="../../../../../org/apache/commons/httpclient/Cookie.html"><CODE>Cookie</CODE></A>.<DD><DL>

512

<DT>Specified by: <DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html#formatCookieHeader(org.apache.commons.httpclient.Cookie)">formatCookieHeader</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></DL>

513

</DD>

514

515

<DT>Parameters:<DD><CODE>cookie</CODE> - <tt>Cookie</tt>s to be formatted as a <tt>Cookie</tt>

516

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

517

</DD>

518

</DL>

519

520

<HR>

521

522

523

524

525

<TR>

526

527

528

529

530

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

531

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

532

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

533

534

535

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

536

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

537

538

</TR>

539

</TABLE>

540

</TD>

541

542

543

</TD>

544

</TR>

545

546

<TR>

547

548

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

549

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

550

551

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

552

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

553

</TR>

554

<TR>

555

556

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

557

558

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

559

</TR>

560

</TABLE>

561

562

563

<HR>

564

565

</BODY>

566

</HTML>

Older »