cachecontrol.html.svn-base

portal越来越流行了

          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&nbsp;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&nbsp;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&nbsp;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&nbsp;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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CacheControl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../javax/portlet/BaseURL.html" title="interface in javax.portlet"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<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>  &nbsp;
&nbsp;<A HREF="CacheControl.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>