1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
5
<!-- Generated by javadoc on Sun Oct 10 17:41:05 EDT 2004 -->
7
HttpClient 2.0.2 API: Class CookiePolicy
9
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
11
<BODY BGCOLOR="white">
13
<!-- ========== START OF NAVBAR ========== -->
14
<A NAME="navbar_top"><!-- --></A>
15
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
17
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
18
<A NAME="navbar_top_firstrow"><!-- --></A>
19
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
20
<TR ALIGN="center" VALIGN="top">
21
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
22
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
23
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
24
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CookiePolicy.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
25
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
26
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
27
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
28
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
32
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
38
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
39
PREV CLASS
40
<A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.html"><B>NEXT CLASS</B></A></FONT></TD>
41
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
42
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
43
<A HREF="CookiePolicy.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
46
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
47
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
48
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
49
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
52
<!-- =========== END OF NAVBAR =========== -->
55
<!-- ======== START OF CLASS DATA ======== -->
58
org.apache.commons.httpclient.cookie</FONT>
60
Class CookiePolicy</H2>
62
<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">java.lang.Object</A>
64
+--<B>org.apache.commons.httpclient.cookie.CookiePolicy</B>
68
<DT>public abstract class <B>CookiePolicy</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">Object</A></DL>
71
Cookie management policy class. The cookie policy provides corresponding
72
cookie management interfrace for a given type or version of cookie.
73
<p>RFC 2109 specification is used per default. Other supported specification
74
can be chosen when appropriate or set default when desired
75
<p>The following specifications are provided:
77
<li><tt>COMPATIBILITY</tt>: compatible with the common cookie management
78
practices * (even if they are not 100% standards compliant)
79
<li><tt>NETSCAPE_DRAFT</tt>: Netscape cookie draft compliant
80
<li><tt>RFC2109</tt>: RFC2109 compliant (default)
82
<p>Default policy can be set on JVM start-up through the system property
83
<tt>"apache.commons.httpclient.cookiespec"</tt>. Recognized values:
84
<tt>COMPATIBILITY</tt>, <tt>NETSCAPE_DRAFT</tt>, <tt>RFC2109</tt>.
87
<DT><B>Since: </B><DD>2.0</DD>
88
<DT><B>Author: </B><DD><a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>, <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a></DD>
93
<!-- ======== INNER CLASS SUMMARY ======== -->
96
<!-- =========== FIELD SUMMARY =========== -->
98
<A NAME="field_summary"><!-- --></A>
99
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
100
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
101
<TD COLSPAN=2><FONT SIZE="+2">
102
<B>Field Summary</B></FONT></TD>
104
<TR BGCOLOR="white" CLASS="TableRowColor">
105
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
106
<CODE>static int</CODE></FONT></TD>
107
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#COMPATIBILITY">COMPATIBILITY</A></B></CODE>
110
The <tt>COMPATIBILITY</tt> policy provides high compatibilty
111
with common cookie management of popular HTTP agents.</TD>
113
<TR BGCOLOR="white" CLASS="TableRowColor">
114
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
115
<CODE>protected static <A HREF="http://jakarta.apache.org/commons/logging/apidocs/org/apache/commons/logging/Log.html">Log</A></CODE></FONT></TD>
116
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#LOG">LOG</A></B></CODE>
119
Log object.</TD>
121
<TR BGCOLOR="white" CLASS="TableRowColor">
122
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
123
<CODE>static int</CODE></FONT></TD>
124
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#NETSCAPE_DRAFT">NETSCAPE_DRAFT</A></B></CODE>
127
The <tt>NETSCAPE_DRAFT</tt> Netscape draft compliant policy.</TD>
129
<TR BGCOLOR="white" CLASS="TableRowColor">
130
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131
<CODE>static int</CODE></FONT></TD>
132
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#RFC2109">RFC2109</A></B></CODE>
135
The <tt>RFC2109</tt> RFC 2109 compliant policy.</TD>
139
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
141
<A NAME="constructor_summary"><!-- --></A>
142
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
143
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
144
<TD COLSPAN=2><FONT SIZE="+2">
145
<B>Constructor Summary</B></FONT></TD>
147
<TR BGCOLOR="white" CLASS="TableRowColor">
148
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#CookiePolicy()">CookiePolicy</A></B>()</CODE>
151
</TD>
155
<!-- ========== METHOD SUMMARY =========== -->
157
<A NAME="method_summary"><!-- --></A>
158
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
159
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
160
<TD COLSPAN=2><FONT SIZE="+2">
161
<B>Method Summary</B></FONT></TD>
163
<TR BGCOLOR="white" CLASS="TableRowColor">
164
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165
<CODE>(package private) static void</CODE></FONT></TD>
166
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#<clinit>()"><clinit></A></B>()</CODE>
169
</TD>
171
<TR BGCOLOR="white" CLASS="TableRowColor">
172
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173
<CODE>static <A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></FONT></TD>
174
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#getCompatibilitySpec()">getCompatibilitySpec</A></B>()</CODE>
177
</TD>
179
<TR BGCOLOR="white" CLASS="TableRowColor">
180
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181
<CODE>static int</CODE></FONT></TD>
182
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#getDefaultPolicy()">getDefaultPolicy</A></B>()</CODE>
185
</TD>
187
<TR BGCOLOR="white" CLASS="TableRowColor">
188
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189
<CODE>static <A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></FONT></TD>
190
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#getDefaultSpec()">getDefaultSpec</A></B>()</CODE>
193
</TD>
195
<TR BGCOLOR="white" CLASS="TableRowColor">
196
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
197
<CODE>static <A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></FONT></TD>
198
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#getSpecByPolicy(int)">getSpecByPolicy</A></B>(int policy)</CODE>
201
</TD>
203
<TR BGCOLOR="white" CLASS="TableRowColor">
204
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
205
<CODE>static <A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A></CODE></FONT></TD>
206
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#getSpecByVersion(int)">getSpecByVersion</A></B>(int ver)</CODE>
209
Gets the CookieSpec for a particular cookie version.</TD>
211
<TR BGCOLOR="white" CLASS="TableRowColor">
212
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213
<CODE>static void</CODE></FONT></TD>
214
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/cookie/CookiePolicy.html#setDefaultPolicy(int)">setDefaultPolicy</A></B>(int policy)</CODE>
217
</TD>
220
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
221
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
222
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
223
<TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">Object</A></B></TD>
225
<TR BGCOLOR="white" CLASS="TableRowColor">
226
<TD><CODE><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>
232
<!-- ============ FIELD DETAIL =========== -->
234
<A NAME="field_detail"><!-- --></A>
235
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
236
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
237
<TD COLSPAN=1><FONT SIZE="+2">
238
<B>Field Detail</B></FONT></TD>
242
<A NAME="COMPATIBILITY"><!-- --></A><H3>
245
public static final int <B>COMPATIBILITY</B></PRE>
247
<DD>The <tt>COMPATIBILITY</tt> policy provides high compatibilty
248
with common cookie management of popular HTTP agents.</DL>
251
<A NAME="NETSCAPE_DRAFT"><!-- --></A><H3>
254
public static final int <B>NETSCAPE_DRAFT</B></PRE>
256
<DD>The <tt>NETSCAPE_DRAFT</tt> Netscape draft compliant policy.</DL>
259
<A NAME="RFC2109"><!-- --></A><H3>
262
public static final int <B>RFC2109</B></PRE>
264
<DD>The <tt>RFC2109</tt> RFC 2109 compliant policy.</DL>
267
<A NAME="LOG"><!-- --></A><H3>
270
protected static final <A HREF="http://jakarta.apache.org/commons/logging/apidocs/org/apache/commons/logging/Log.html">Log</A> <B>LOG</B></PRE>
274
<!-- ========= CONSTRUCTOR DETAIL ======== -->
276
<A NAME="constructor_detail"><!-- --></A>
277
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
278
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
279
<TD COLSPAN=1><FONT SIZE="+2">
280
<B>Constructor Detail</B></FONT></TD>
284
<A NAME="CookiePolicy()"><!-- --></A><H3>
287
public <B>CookiePolicy</B>()</PRE>
291
<!-- ============ METHOD DETAIL ========== -->
293
<A NAME="method_detail"><!-- --></A>
294
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
295
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
296
<TD COLSPAN=1><FONT SIZE="+2">
297
<B>Method Detail</B></FONT></TD>
301
<A NAME="<clinit>()"><!-- --></A><H3>
304
static void <B><clinit></B>()</PRE>
309
<A NAME="getDefaultPolicy()"><!-- --></A><H3>
310
getDefaultPolicy</H3>
312
public static int <B>getDefaultPolicy</B>()</PRE>
315
<DT><B>Returns:</B><DD>default cookie policy
316
<tt>(COMPATIBILITY | NETSCAPE_DRAFT | RFC2109)</tt></DL>
321
<A NAME="setDefaultPolicy(int)"><!-- --></A><H3>
322
setDefaultPolicy</H3>
324
public static void <B>setDefaultPolicy</B>(int policy)</PRE>
327
<DT><B>Parameters:</B><DD><CODE>policy</CODE> - new default cookie policy
328
<tt>(COMPATIBILITY | NETSCAPE_DRAFT | RFC2109)</tt></DL>
333
<A NAME="getSpecByPolicy(int)"><!-- --></A><H3>
336
public static <A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A> <B>getSpecByPolicy</B>(int policy)</PRE>
339
<DT><B>Parameters:</B><DD><CODE>policy</CODE> - cookie policy to get the CookieSpec for<DT><B>Returns:</B><DD>cookie specification interface for the given policy
340
<tt>(COMPATIBILITY | NETSCAPE_DRAFT | RFC2109)</tt></DL>
345
<A NAME="getDefaultSpec()"><!-- --></A><H3>
348
public static <A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A> <B>getDefaultSpec</B>()</PRE>
351
<DT><B>Returns:</B><DD>default cookie specification interface</DL>
356
<A NAME="getSpecByVersion(int)"><!-- --></A><H3>
357
getSpecByVersion</H3>
359
public static <A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A> <B>getSpecByVersion</B>(int ver)</PRE>
361
<DD>Gets the CookieSpec for a particular cookie version.
363
<p>Supported versions:
365
<li><tt>version 0</tt> corresponds to the NETSCAPE_DRAFT
366
<li><tt>version 1</tt> corresponds to the RFC2109
367
<li>Any other cookie value coresponds to the default spec
369
<DT><B>Parameters:</B><DD><CODE>ver</CODE> - the cookie version to get the spec for<DT><B>Returns:</B><DD>cookie specification interface intended for processing
370
cookies with the given version</DL>
375
<A NAME="getCompatibilitySpec()"><!-- --></A><H3>
376
getCompatibilitySpec</H3>
378
public static <A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</A> <B>getCompatibilitySpec</B>()</PRE>
381
<DT><B>Returns:</B><DD>cookie specification interface that provides high compatibilty
382
with common cookie management of popular HTTP agents</DL>
385
<!-- ========= END OF CLASS DATA ========= -->
388
<!-- ========== START OF NAVBAR ========== -->
389
<A NAME="navbar_bottom"><!-- --></A>
390
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
392
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
393
<A NAME="navbar_bottom_firstrow"><!-- --></A>
394
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
395
<TR ALIGN="center" VALIGN="top">
396
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
397
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
398
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
399
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CookiePolicy.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
400
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
401
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
402
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
403
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
407
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
413
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
414
PREV CLASS
415
<A HREF="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.html"><B>NEXT CLASS</B></A></FONT></TD>
416
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
417
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
418
<A HREF="CookiePolicy.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
421
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
422
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
423
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
424
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
427
<!-- =========== END OF NAVBAR =========== -->
430
Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.
added
removed
docs/apidocs/org/apache/commons/httpclient/cookie/CookiePolicy.html
