Mercurial > hg > AnnotationManager

comparison libs/httpcomponents-client-4.0-beta1/javadoc/httpclient/org/apache/http/cookie/SetCookie2.html @ 5:0be9d53a6967

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
editor for annotations
author dwinter
date Tue, 13 Dec 2011 17:43:46 +0100
parents
children
comparison
equal deleted inserted replaced
4:c32080f364c6 5:0be9d53a6967
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.5.0_11) on Sat Aug 23 11:49:49 GMT+01:00 2008 -->
6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7 <TITLE>
8 SetCookie2 (HttpClient 4.0-beta1 API)
9 </TITLE>
10
11 <META NAME="keywords" CONTENT="org.apache.http.cookie.SetCookie2 interface">
12
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
14
15 <SCRIPT type="text/javascript">
16 function windowTitle()
17 {
18 parent.document.title="SetCookie2 (HttpClient 4.0-beta1 API)";
19 }
20 </SCRIPT>
21 <NOSCRIPT>
22 </NOSCRIPT>
23
24 </HEAD>
25
26 <BODY BGCOLOR="white" onload="windowTitle();">
27
28
29 <!-- ========= START OF TOP NAVBAR ======= -->
30 <A NAME="navbar_top"><!-- --></A>
31 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
32 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
33 <TR>
34 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
35 <A NAME="navbar_top_firstrow"><!-- --></A>
36 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
37 <TR ALIGN="center" VALIGN="top">
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SetCookie2.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
46 </TR>
47 </TABLE>
48 </TD>
49 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
50 </EM>
51 </TD>
52 </TR>
53
54 <TR>
55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
56 &nbsp;<A HREF="../../../../org/apache/http/cookie/SetCookie.html" title="interface in org.apache.http.cookie"><B>PREV CLASS</B></A>&nbsp;
57 &nbsp;<A HREF="../../../../org/apache/http/cookie/SM.html" title="interface in org.apache.http.cookie"><B>NEXT CLASS</B></A></FONT></TD>
58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59 <A HREF="../../../../index.html?org/apache/http/cookie/SetCookie2.html" target="_top"><B>FRAMES</B></A> &nbsp;
60 &nbsp;<A HREF="SetCookie2.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
61 &nbsp;<SCRIPT type="text/javascript">
62 <!--
63 if(window==top) {
64 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
65 }
66 //-->
67 </SCRIPT>
68 <NOSCRIPT>
69 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
70 </NOSCRIPT>
71
72
73 </FONT></TD>
74 </TR>
75 <TR>
76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
80 </TR>
81 </TABLE>
82 <A NAME="skip-navbar_top"></A>
83 <!-- ========= END OF TOP NAVBAR ========= -->
84
85 <HR>
86 <!-- ======== START OF CLASS DATA ======== -->
87 <H2>
88 <FONT SIZE="-1">
89 org.apache.http.cookie</FONT>
90 <BR>
91 Interface SetCookie2</H2>
92 <DL>
93 <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/http/cookie/Cookie.html" title="interface in org.apache.http.cookie">Cookie</A>, <A HREF="../../../../org/apache/http/cookie/SetCookie.html" title="interface in org.apache.http.cookie">SetCookie</A></DD>
94 </DL>
95 <DL>
96 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/http/impl/cookie/BasicClientCookie2.html" title="class in org.apache.http.impl.cookie">BasicClientCookie2</A></DD>
97 </DL>
98 <HR>
99 <DL>
100 <DT><PRE>public interface <B>SetCookie2</B><DT>extends <A HREF="../../../../org/apache/http/cookie/SetCookie.html" title="interface in org.apache.http.cookie">SetCookie</A></DL>
101 </PRE>
102
103 <P>
104 This interface represents a <code>SetCookie2</code> response header sent by the
105 origin server to the HTTP agent in order to maintain a conversational state.
106 <P>
107
108 <P>
109 <DL>
110 <DT><B>Since:</B></DT>
111 <DD>4.0</DD>
112 <DT><B>Author:</B></DT>
113 <DD><a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a></DD>
114 </DL>
115 <HR>
116
117 <P>
118
119 <!-- ========== METHOD SUMMARY =========== -->
120
121 <A NAME="method_summary"><!-- --></A>
122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125 <B>Method Summary</B></FONT></TH>
126 </TR>
127 <TR BGCOLOR="white" CLASS="TableRowColor">
128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129 <CODE>&nbsp;void</CODE></FONT></TD>
130 <TD><CODE><B><A HREF="../../../../org/apache/http/cookie/SetCookie2.html#setCommentURL(java.lang.String)">setCommentURL</A></B>(java.lang.String&nbsp;commentURL)</CODE>
131
132 <BR>
133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If a user agent (web browser) presents this cookie to a user, the
134 cookie's purpose will be described by the information at this URL.</TD>
135 </TR>
136 <TR BGCOLOR="white" CLASS="TableRowColor">
137 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138 <CODE>&nbsp;void</CODE></FONT></TD>
139 <TD><CODE><B><A HREF="../../../../org/apache/http/cookie/SetCookie2.html#setDiscard(boolean)">setDiscard</A></B>(boolean&nbsp;discard)</CODE>
140
141 <BR>
142 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the Discard attribute.</TD>
143 </TR>
144 <TR BGCOLOR="white" CLASS="TableRowColor">
145 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146 <CODE>&nbsp;void</CODE></FONT></TD>
147 <TD><CODE><B><A HREF="../../../../org/apache/http/cookie/SetCookie2.html#setPorts(int[])">setPorts</A></B>(int[]&nbsp;ports)</CODE>
148
149 <BR>
150 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the Port attribute.</TD>
151 </TR>
152 </TABLE>
153 &nbsp;<A NAME="methods_inherited_from_class_org.apache.http.cookie.SetCookie"><!-- --></A>
154 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
155 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
156 <TH ALIGN="left"><B>Methods inherited from interface org.apache.http.cookie.<A HREF="../../../../org/apache/http/cookie/SetCookie.html" title="interface in org.apache.http.cookie">SetCookie</A></B></TH>
157 </TR>
158 <TR BGCOLOR="white" CLASS="TableRowColor">
159 <TD><CODE><A HREF="../../../../org/apache/http/cookie/SetCookie.html#setComment(java.lang.String)">setComment</A>, <A HREF="../../../../org/apache/http/cookie/SetCookie.html#setDomain(java.lang.String)">setDomain</A>, <A HREF="../../../../org/apache/http/cookie/SetCookie.html#setExpiryDate(java.util.Date)">setExpiryDate</A>, <A HREF="../../../../org/apache/http/cookie/SetCookie.html#setPath(java.lang.String)">setPath</A>, <A HREF="../../../../org/apache/http/cookie/SetCookie.html#setSecure(boolean)">setSecure</A>, <A HREF="../../../../org/apache/http/cookie/SetCookie.html#setValue(java.lang.String)">setValue</A>, <A HREF="../../../../org/apache/http/cookie/SetCookie.html#setVersion(int)">setVersion</A></CODE></TD>
160 </TR>
161 </TABLE>
162 &nbsp;<A NAME="methods_inherited_from_class_org.apache.http.cookie.Cookie"><!-- --></A>
163 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
164 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
165 <TH ALIGN="left"><B>Methods inherited from interface org.apache.http.cookie.<A HREF="../../../../org/apache/http/cookie/Cookie.html" title="interface in org.apache.http.cookie">Cookie</A></B></TH>
166 </TR>
167 <TR BGCOLOR="white" CLASS="TableRowColor">
168 <TD><CODE><A HREF="../../../../org/apache/http/cookie/Cookie.html#getComment()">getComment</A>, <A HREF="../../../../org/apache/http/cookie/Cookie.html#getCommentURL()">getCommentURL</A>, <A HREF="../../../../org/apache/http/cookie/Cookie.html#getDomain()">getDomain</A>, <A HREF="../../../../org/apache/http/cookie/Cookie.html#getExpiryDate()">getExpiryDate</A>, <A HREF="../../../../org/apache/http/cookie/Cookie.html#getName()">getName</A>, <A HREF="../../../../org/apache/http/cookie/Cookie.html#getPath()">getPath</A>, <A HREF="../../../../org/apache/http/cookie/Cookie.html#getPorts()">getPorts</A>, <A HREF="../../../../org/apache/http/cookie/Cookie.html#getValue()">getValue</A>, <A HREF="../../../../org/apache/http/cookie/Cookie.html#getVersion()">getVersion</A>, <A HREF="../../../../org/apache/http/cookie/Cookie.html#isExpired(java.util.Date)">isExpired</A>, <A HREF="../../../../org/apache/http/cookie/Cookie.html#isPersistent()">isPersistent</A>, <A HREF="../../../../org/apache/http/cookie/Cookie.html#isSecure()">isSecure</A></CODE></TD>
169 </TR>
170 </TABLE>
171 &nbsp;
172 <P>
173
174 <!-- ============ METHOD DETAIL ========== -->
175
176 <A NAME="method_detail"><!-- --></A>
177 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
178 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
179 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
180 <B>Method Detail</B></FONT></TH>
181 </TR>
182 </TABLE>
183
184 <A NAME="setCommentURL(java.lang.String)"><!-- --></A><H3>
185 setCommentURL</H3>
186 <PRE>
187 void <B>setCommentURL</B>(java.lang.String&nbsp;commentURL)</PRE>
188 <DL>
189 <DD>If a user agent (web browser) presents this cookie to a user, the
190 cookie's purpose will be described by the information at this URL.
191 <P>
192 <DD><DL>
193 </DL>
194 </DD>
195 <DD><DL>
196 </DL>
197 </DD>
198 </DL>
199 <HR>
200
201 <A NAME="setPorts(int[])"><!-- --></A><H3>
202 setPorts</H3>
203 <PRE>
204 void <B>setPorts</B>(int[]&nbsp;ports)</PRE>
205 <DL>
206 <DD>Sets the Port attribute. It restricts the ports to which a cookie
207 may be returned in a Cookie request header.
208 <P>
209 <DD><DL>
210 </DL>
211 </DD>
212 <DD><DL>
213 </DL>
214 </DD>
215 </DL>
216 <HR>
217
218 <A NAME="setDiscard(boolean)"><!-- --></A><H3>
219 setDiscard</H3>
220 <PRE>
221 void <B>setDiscard</B>(boolean&nbsp;discard)</PRE>
222 <DL>
223 <DD>Set the Discard attribute.
224
225 Note: <tt>Discard</tt> attribute overrides <tt>Max-age</tt>.
226 <P>
227 <DD><DL>
228 </DL>
229 </DD>
230 <DD><DL>
231 <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/http/cookie/Cookie.html#isPersistent()"><CODE>Cookie.isPersistent()</CODE></A></DL>
232 </DD>
233 </DL>
234 <!-- ========= END OF CLASS DATA ========= -->
235 <HR>
236
237
238 <!-- ======= START OF BOTTOM NAVBAR ====== -->
239 <A NAME="navbar_bottom"><!-- --></A>
240 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
241 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
242 <TR>
243 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
244 <A NAME="navbar_bottom_firstrow"><!-- --></A>
245 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
246 <TR ALIGN="center" VALIGN="top">
247 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
248 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
249 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
250 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SetCookie2.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
251 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
252 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
253 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
254 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
255 </TR>
256 </TABLE>
257 </TD>
258 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
259 </EM>
260 </TD>
261 </TR>
262
263 <TR>
264 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
265 &nbsp;<A HREF="../../../../org/apache/http/cookie/SetCookie.html" title="interface in org.apache.http.cookie"><B>PREV CLASS</B></A>&nbsp;
266 &nbsp;<A HREF="../../../../org/apache/http/cookie/SM.html" title="interface in org.apache.http.cookie"><B>NEXT CLASS</B></A></FONT></TD>
267 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
268 <A HREF="../../../../index.html?org/apache/http/cookie/SetCookie2.html" target="_top"><B>FRAMES</B></A> &nbsp;
269 &nbsp;<A HREF="SetCookie2.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
270 &nbsp;<SCRIPT type="text/javascript">
271 <!--
272 if(window==top) {
273 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
274 }
275 //-->
276 </SCRIPT>
277 <NOSCRIPT>
278 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
279 </NOSCRIPT>
280
281
282 </FONT></TD>
283 </TR>
284 <TR>
285 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
286 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
287 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
288 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
289 </TR>
290 </TABLE>
291 <A NAME="skip-navbar_bottom"></A>
292 <!-- ======== END OF BOTTOM NAVBAR ======= -->
293
294 <HR>
295 Copyright © 1999-2008 <a href="http://www.apache.org/">Apache Software Foundation</a>. All Rights Reserved.
296 </BODY>
297 </HTML>