/usr/share/doc/libportlet-api-2.0-spec-java/api/javax/portlet/CacheControl.html is in libportlet-api-2.0-spec-java-doc 1.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_20) on Sun Jun 27 09:02:34 UTC 2010 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
CacheControl (Java Portlet Specification V2.0 1.0 API)
</TITLE>
<META NAME="date" CONTENT="2010-06-27">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CacheControl (Java Portlet Specification V2.0 1.0 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CacheControl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../javax/portlet/BaseURL.html" title="interface in javax.portlet"><B>PREV CLASS</B></A>
<A HREF="../../javax/portlet/ClientDataRequest.html" title="interface in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?javax/portlet/CacheControl.html" target="_top"><B>FRAMES</B></A>
<A HREF="CacheControl.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
javax.portlet</FONT>
<BR>
Interface CacheControl</H2>
<HR>
<DL>
<DT><PRE>public interface <B>CacheControl</B></DL>
</PRE>
<P>
The <code>CacheControl</code> interface represents cache settings
for a piece of markup. The settings are only valid for the current
request.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/CacheControl.html#getETag()">getETag</A></B>()</CODE>
<BR>
Returns the ETag for the current response that is
used as validation tag, or <code>null</null>
if no ETag is set on the response.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/CacheControl.html#getExpirationTime()">getExpirationTime</A></B>()</CODE>
<BR>
Get the currently set expiration time.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/CacheControl.html#isPublicScope()">isPublicScope</A></B>()</CODE>
<BR>
Returns a boolean indicating whether the
caching scope is set to public for the current response.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/CacheControl.html#setETag(java.lang.String)">setETag</A></B>(java.lang.String token)</CODE>
<BR>
Sets an ETag for the current response that is
used as validation tag.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/CacheControl.html#setExpirationTime(int)">setExpirationTime</A></B>(int time)</CODE>
<BR>
Sets a new expiration time for the current response
in seconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/CacheControl.html#setPublicScope(boolean)">setPublicScope</A></B>(boolean publicScope)</CODE>
<BR>
Sets the caching scope for the current response
to public with <code>true</code> as
<code>publicScope</code> and to private with
<code>false</code> as <code>publicScope</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/CacheControl.html#setUseCachedContent(boolean)">setUseCachedContent</A></B>(boolean useCachedContent)</CODE>
<BR>
Sets the indication whether the cached content
for the provided ETag at the request is still valid or not.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/CacheControl.html#useCachedContent()">useCachedContent</A></B>()</CODE>
<BR>
Returns a boolean indicating whether the
cached content for the provided ETag at the request
can still be considerated valid.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getExpirationTime()"><!-- --></A><H3>
getExpirationTime</H3>
<PRE>
int <B>getExpirationTime</B>()</PRE>
<DL>
<DD>Get the currently set expiration time.
If no expiration time is set on this response the
default defined in the portlet deployment descriptor
with the <code>expiration-cache<code> tag is returned,
or <code>0</code> if no default is defined.
<p>
This call returns the same value as the
<code>getProperty(EXPIRATION_CACHE)</code>
call.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the currently set expiration time in seconds,
or <code>0</code> if no expiration time
is set.</DL>
</DD>
</DL>
<HR>
<A NAME="setExpirationTime(int)"><!-- --></A><H3>
setExpirationTime</H3>
<PRE>
void <B>setExpirationTime</B>(int time)</PRE>
<DL>
<DD>Sets a new expiration time for the current response
in seconds.
<p>
If the expiration value is set to 0, caching is disabled for this
portlet; if the value is set to -1, the cache does not expire.
<p>
This call is equivalent to calling
<code>setProperty(EXPIRATION_CACHE)</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>time</CODE> - expiration time in seconds</DL>
</DD>
</DL>
<HR>
<A NAME="isPublicScope()"><!-- --></A><H3>
isPublicScope</H3>
<PRE>
boolean <B>isPublicScope</B>()</PRE>
<DL>
<DD>Returns a boolean indicating whether the
caching scope is set to public for the current response.
If no caching scope is set on this response, the default
defined in the deployment descriptor with the
<code>cache-scope</code> tag is returned,
or <code>false</code> if no default is defined.
<p>
Public cache scope indicates that the cache entry can be shared across
users. Non-public, or private cache scope indicates that the cache entry
must not be shared across users.
<p>
This call is equivalent to calling
<code>getProperty(CACHE_SCOPE).equals(PUBLIC_SCOPE)</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the cache scope is public for the
current response.</DL>
</DD>
</DL>
<HR>
<A NAME="setPublicScope(boolean)"><!-- --></A><H3>
setPublicScope</H3>
<PRE>
void <B>setPublicScope</B>(boolean publicScope)</PRE>
<DL>
<DD>Sets the caching scope for the current response
to public with <code>true</code> as
<code>publicScope</code> and to private with
<code>false</code> as <code>publicScope</code>.
<p>
Public cache scope indicates that the cache entry can be shared across
users. Non-public, or private cache scope indicates that the cache entry
must not be shared across users.
<p>
This call is equivalent to calling
<code>(publicScope ? setProperty(CACHE_SCOPE, PUBLIC_SCOPE |
setProperty(CACHE_SCOPE, PRIVATE_SCOPE)</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>publicScope</CODE> - indicating if the cache entry can be shared across users</DL>
</DD>
</DL>
<HR>
<A NAME="getETag()"><!-- --></A><H3>
getETag</H3>
<PRE>
java.lang.String <B>getETag</B>()</PRE>
<DL>
<DD>Returns the ETag for the current response that is
used as validation tag, or <code>null</null>
if no ETag is set on the response.
<p>
This call is equivalent to calling
<code>getProperty(ETAG)</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the ETag for the current response that is
used as validation tag, or <code>null</null>
if no ETag is set.</DL>
</DD>
</DL>
<HR>
<A NAME="setETag(java.lang.String)"><!-- --></A><H3>
setETag</H3>
<PRE>
void <B>setETag</B>(java.lang.String token)</PRE>
<DL>
<DD>Sets an ETag for the current response that is
used as validation tag. If an ETag was already
set it is replaced with the new value.
<p>
This call is equivalent to calling
<code>setProperty(ETAG, token)</code>.
<p>
Setting the ETag to <code>null</code> removes
the currently set ETag.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>token</CODE> - the ETag token</DL>
</DD>
</DL>
<HR>
<A NAME="useCachedContent()"><!-- --></A><H3>
useCachedContent</H3>
<PRE>
boolean <B>useCachedContent</B>()</PRE>
<DL>
<DD>Returns a boolean indicating whether the
cached content for the provided ETag at the request
can still be considerated valid.
If not set, the default is <code>false</code>.
<p>
This call is equivalent to calling
<code>getProperty(USE_CACHED_CONTENT)</code> and getting a non-null
value back.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>boolean indicating whether the
caching scope is set to public for the current response</DL>
</DD>
</DL>
<HR>
<A NAME="setUseCachedContent(boolean)"><!-- --></A><H3>
setUseCachedContent</H3>
<PRE>
void <B>setUseCachedContent</B>(boolean useCachedContent)</PRE>
<DL>
<DD>Sets the indication whether the cached content
for the provided ETag at the request is still valid or not.
If set to <code>true</code> no output should be rendered,
but a new expiration time should be set for the
markup with the given ETag .
<p>
This call is equivalent to calling
<code>setProperty(USE_CACHED_CONTENT, "true")</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>useCachedContent</CODE> - boolean indication whether the
the cached content is still valid or not</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CacheControl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../javax/portlet/BaseURL.html" title="interface in javax.portlet"><B>PREV CLASS</B></A>
<A HREF="../../javax/portlet/ClientDataRequest.html" title="interface in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?javax/portlet/CacheControl.html" target="_top"><B>FRAMES</B></A>
<A HREF="CacheControl.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2010. All Rights Reserved.
</BODY>
</HTML>
|