[7588] | 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.6.0_24) on Mon Jun 25 15:26:25 EDT 2012 --> |
---|
| 6 | <META http-equiv="Content-Type" content="text/html; charset=utf-8"> |
---|
| 7 | <TITLE> |
---|
| 8 | HttpCacheHeaderUtil (Solr 4.0.0-ALPHA API) |
---|
| 9 | </TITLE> |
---|
| 10 | |
---|
| 11 | <META NAME="date" CONTENT="2012-06-25"> |
---|
| 12 | |
---|
| 13 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
---|
| 14 | |
---|
| 15 | <SCRIPT type="text/javascript"> |
---|
| 16 | function windowTitle() |
---|
| 17 | { |
---|
| 18 | if (location.href.indexOf('is-external=true') == -1) { |
---|
| 19 | parent.document.title="HttpCacheHeaderUtil (Solr 4.0.0-ALPHA API)"; |
---|
| 20 | } |
---|
| 21 | } |
---|
| 22 | </SCRIPT> |
---|
| 23 | <NOSCRIPT> |
---|
| 24 | </NOSCRIPT> |
---|
| 25 | |
---|
| 26 | </HEAD> |
---|
| 27 | |
---|
| 28 | <BODY BGCOLOR="white" onload="windowTitle();"> |
---|
| 29 | <HR> |
---|
| 30 | |
---|
| 31 | |
---|
| 32 | <!-- ========= START OF TOP NAVBAR ======= --> |
---|
| 33 | <A NAME="navbar_top"><!-- --></A> |
---|
| 34 | <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
---|
| 35 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
| 36 | <TR> |
---|
| 37 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 38 | <A NAME="navbar_top_firstrow"><!-- --></A> |
---|
| 39 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
| 40 | <TR ALIGN="center" VALIGN="top"> |
---|
| 41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 42 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 43 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/HttpCacheHeaderUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 47 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 48 | </TR> |
---|
| 49 | </TABLE> |
---|
| 50 | </TD> |
---|
| 51 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 52 | </EM> |
---|
| 53 | </TD> |
---|
| 54 | </TR> |
---|
| 55 | |
---|
| 56 | <TR> |
---|
| 57 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 58 | PREV CLASS |
---|
| 59 | <A HREF="../../../../../org/apache/solr/servlet/cache/Method.html" title="enum in org.apache.solr.servlet.cache"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 60 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 61 | <A HREF="../../../../../index.html?org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html" target="_top"><B>FRAMES</B></A> |
---|
| 62 | <A HREF="HttpCacheHeaderUtil.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 63 | <SCRIPT type="text/javascript"> |
---|
| 64 | <!-- |
---|
| 65 | if(window==top) { |
---|
| 66 | document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
| 67 | } |
---|
| 68 | //--> |
---|
| 69 | </SCRIPT> |
---|
| 70 | <NOSCRIPT> |
---|
| 71 | <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
| 72 | </NOSCRIPT> |
---|
| 73 | |
---|
| 74 | |
---|
| 75 | </FONT></TD> |
---|
| 76 | </TR> |
---|
| 77 | <TR> |
---|
| 78 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 79 | SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 81 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 82 | </TR> |
---|
| 83 | </TABLE> |
---|
| 84 | <A NAME="skip-navbar_top"></A> |
---|
| 85 | <!-- ========= END OF TOP NAVBAR ========= --> |
---|
| 86 | |
---|
| 87 | <HR> |
---|
| 88 | <!-- ======== START OF CLASS DATA ======== --> |
---|
| 89 | <H2> |
---|
| 90 | <FONT SIZE="-1"> |
---|
| 91 | org.apache.solr.servlet.cache</FONT> |
---|
| 92 | <BR> |
---|
| 93 | Class HttpCacheHeaderUtil</H2> |
---|
| 94 | <PRE> |
---|
| 95 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
---|
| 96 | <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.servlet.cache.HttpCacheHeaderUtil</B> |
---|
| 97 | </PRE> |
---|
| 98 | <HR> |
---|
| 99 | <DL> |
---|
| 100 | <DT><PRE>public final class <B>HttpCacheHeaderUtil</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> |
---|
| 101 | </PRE> |
---|
| 102 | |
---|
| 103 | <P> |
---|
| 104 | <HR> |
---|
| 105 | |
---|
| 106 | <P> |
---|
| 107 | |
---|
| 108 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
| 109 | |
---|
| 110 | <A NAME="constructor_summary"><!-- --></A> |
---|
| 111 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 112 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 113 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 114 | <B>Constructor Summary</B></FONT></TH> |
---|
| 115 | </TR> |
---|
| 116 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 117 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html#HttpCacheHeaderUtil()">HttpCacheHeaderUtil</A></B>()</CODE> |
---|
| 118 | |
---|
| 119 | <BR> |
---|
| 120 | </TD> |
---|
| 121 | </TR> |
---|
| 122 | </TABLE> |
---|
| 123 | |
---|
| 124 | <!-- ========== METHOD SUMMARY =========== --> |
---|
| 125 | |
---|
| 126 | <A NAME="method_summary"><!-- --></A> |
---|
| 127 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 128 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 129 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 130 | <B>Method Summary</B></FONT></TH> |
---|
| 131 | </TR> |
---|
| 132 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 133 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 134 | <CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
---|
| 135 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html#calcEtag(org.apache.solr.request.SolrQueryRequest)">calcEtag</A></B>(<A HREF="../../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A> solrReq)</CODE> |
---|
| 136 | |
---|
| 137 | <BR> |
---|
| 138 | Calculates a tag for the ETag header.</TD> |
---|
| 139 | </TR> |
---|
| 140 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 141 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 142 | <CODE>static long</CODE></FONT></TD> |
---|
| 143 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html#calcLastModified(org.apache.solr.request.SolrQueryRequest)">calcLastModified</A></B>(<A HREF="../../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A> solrReq)</CODE> |
---|
| 144 | |
---|
| 145 | <BR> |
---|
| 146 | Calculate the appropriate last-modified time for Solr relative the current request.</TD> |
---|
| 147 | </TR> |
---|
| 148 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 149 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 150 | <CODE>static boolean</CODE></FONT></TD> |
---|
| 151 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html#checkETagValidators(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.solr.servlet.cache.Method, java.lang.String)">checkETagValidators</A></B>(javax.servlet.http.HttpServletRequest req, |
---|
| 152 | javax.servlet.http.HttpServletResponse resp, |
---|
| 153 | <A HREF="../../../../../org/apache/solr/servlet/cache/Method.html" title="enum in org.apache.solr.servlet.cache">Method</A> reqMethod, |
---|
| 154 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> etag)</CODE> |
---|
| 155 | |
---|
| 156 | <BR> |
---|
| 157 | Check for etag related conditional headers and set status</TD> |
---|
| 158 | </TR> |
---|
| 159 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 160 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 161 | <CODE>static void</CODE></FONT></TD> |
---|
| 162 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html#checkHttpCachingVeto(org.apache.solr.response.SolrQueryResponse, javax.servlet.http.HttpServletResponse, org.apache.solr.servlet.cache.Method)">checkHttpCachingVeto</A></B>(<A HREF="../../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A> solrRsp, |
---|
| 163 | javax.servlet.http.HttpServletResponse resp, |
---|
| 164 | <A HREF="../../../../../org/apache/solr/servlet/cache/Method.html" title="enum in org.apache.solr.servlet.cache">Method</A> reqMethod)</CODE> |
---|
| 165 | |
---|
| 166 | <BR> |
---|
| 167 | Checks if the downstream request handler wants to avoid HTTP caching of |
---|
| 168 | the response.</TD> |
---|
| 169 | </TR> |
---|
| 170 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 171 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 172 | <CODE>static boolean</CODE></FONT></TD> |
---|
| 173 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html#checkLastModValidators(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, long)">checkLastModValidators</A></B>(javax.servlet.http.HttpServletRequest req, |
---|
| 174 | javax.servlet.http.HttpServletResponse resp, |
---|
| 175 | long lastMod)</CODE> |
---|
| 176 | |
---|
| 177 | <BR> |
---|
| 178 | Check for modify time related conditional headers and set status</TD> |
---|
| 179 | </TR> |
---|
| 180 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 181 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 182 | <CODE>static boolean</CODE></FONT></TD> |
---|
| 183 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html#doCacheHeaderValidation(org.apache.solr.request.SolrQueryRequest, javax.servlet.http.HttpServletRequest, org.apache.solr.servlet.cache.Method, javax.servlet.http.HttpServletResponse)">doCacheHeaderValidation</A></B>(<A HREF="../../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A> solrReq, |
---|
| 184 | javax.servlet.http.HttpServletRequest req, |
---|
| 185 | <A HREF="../../../../../org/apache/solr/servlet/cache/Method.html" title="enum in org.apache.solr.servlet.cache">Method</A> reqMethod, |
---|
| 186 | javax.servlet.http.HttpServletResponse resp)</CODE> |
---|
| 187 | |
---|
| 188 | <BR> |
---|
| 189 | Sets HTTP Response cache validator headers appropriately and |
---|
| 190 | validates the HTTP Request against these using any conditional |
---|
| 191 | request headers.</TD> |
---|
| 192 | </TR> |
---|
| 193 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 194 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 195 | <CODE>static boolean</CODE></FONT></TD> |
---|
| 196 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html#isMatchingEtag(java.util.List, java.lang.String)">isMatchingEtag</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> headerList, |
---|
| 197 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> etag)</CODE> |
---|
| 198 | |
---|
| 199 | <BR> |
---|
| 200 | Checks if one of the tags in the list equals the given etag.</TD> |
---|
| 201 | </TR> |
---|
| 202 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 203 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 204 | <CODE>static void</CODE></FONT></TD> |
---|
| 205 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html#sendNotModified(javax.servlet.http.HttpServletResponse)">sendNotModified</A></B>(javax.servlet.http.HttpServletResponse res)</CODE> |
---|
| 206 | |
---|
| 207 | <BR> |
---|
| 208 | </TD> |
---|
| 209 | </TR> |
---|
| 210 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 211 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 212 | <CODE>static void</CODE></FONT></TD> |
---|
| 213 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html#sendPreconditionFailed(javax.servlet.http.HttpServletResponse)">sendPreconditionFailed</A></B>(javax.servlet.http.HttpServletResponse res)</CODE> |
---|
| 214 | |
---|
| 215 | <BR> |
---|
| 216 | </TD> |
---|
| 217 | </TR> |
---|
| 218 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 219 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 220 | <CODE>static void</CODE></FONT></TD> |
---|
| 221 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html#setCacheControlHeader(org.apache.solr.core.SolrConfig, javax.servlet.http.HttpServletResponse, org.apache.solr.servlet.cache.Method)">setCacheControlHeader</A></B>(<A HREF="../../../../../org/apache/solr/core/SolrConfig.html" title="class in org.apache.solr.core">SolrConfig</A> conf, |
---|
| 222 | javax.servlet.http.HttpServletResponse resp, |
---|
| 223 | <A HREF="../../../../../org/apache/solr/servlet/cache/Method.html" title="enum in org.apache.solr.servlet.cache">Method</A> method)</CODE> |
---|
| 224 | |
---|
| 225 | <BR> |
---|
| 226 | Set the Cache-Control HTTP header (and Expires if needed) |
---|
| 227 | based on the SolrConfig.</TD> |
---|
| 228 | </TR> |
---|
| 229 | </TABLE> |
---|
| 230 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
| 231 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 232 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
| 233 | <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
---|
| 234 | </TR> |
---|
| 235 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 236 | <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
---|
| 237 | </TR> |
---|
| 238 | </TABLE> |
---|
| 239 | |
---|
| 240 | <P> |
---|
| 241 | |
---|
| 242 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
| 243 | |
---|
| 244 | <A NAME="constructor_detail"><!-- --></A> |
---|
| 245 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 246 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 247 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 248 | <B>Constructor Detail</B></FONT></TH> |
---|
| 249 | </TR> |
---|
| 250 | </TABLE> |
---|
| 251 | |
---|
| 252 | <A NAME="HttpCacheHeaderUtil()"><!-- --></A><H3> |
---|
| 253 | HttpCacheHeaderUtil</H3> |
---|
| 254 | <PRE> |
---|
| 255 | public <B>HttpCacheHeaderUtil</B>()</PRE> |
---|
| 256 | <DL> |
---|
| 257 | </DL> |
---|
| 258 | |
---|
| 259 | <!-- ============ METHOD DETAIL ========== --> |
---|
| 260 | |
---|
| 261 | <A NAME="method_detail"><!-- --></A> |
---|
| 262 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 263 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 264 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 265 | <B>Method Detail</B></FONT></TH> |
---|
| 266 | </TR> |
---|
| 267 | </TABLE> |
---|
| 268 | |
---|
| 269 | <A NAME="sendNotModified(javax.servlet.http.HttpServletResponse)"><!-- --></A><H3> |
---|
| 270 | sendNotModified</H3> |
---|
| 271 | <PRE> |
---|
| 272 | public static void <B>sendNotModified</B>(javax.servlet.http.HttpServletResponse res) |
---|
| 273 | throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
---|
| 274 | <DL> |
---|
| 275 | <DD><DL> |
---|
| 276 | |
---|
| 277 | <DT><B>Throws:</B> |
---|
| 278 | <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
---|
| 279 | </DD> |
---|
| 280 | </DL> |
---|
| 281 | <HR> |
---|
| 282 | |
---|
| 283 | <A NAME="sendPreconditionFailed(javax.servlet.http.HttpServletResponse)"><!-- --></A><H3> |
---|
| 284 | sendPreconditionFailed</H3> |
---|
| 285 | <PRE> |
---|
| 286 | public static void <B>sendPreconditionFailed</B>(javax.servlet.http.HttpServletResponse res) |
---|
| 287 | throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
---|
| 288 | <DL> |
---|
| 289 | <DD><DL> |
---|
| 290 | |
---|
| 291 | <DT><B>Throws:</B> |
---|
| 292 | <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
---|
| 293 | </DD> |
---|
| 294 | </DL> |
---|
| 295 | <HR> |
---|
| 296 | |
---|
| 297 | <A NAME="calcEtag(org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3> |
---|
| 298 | calcEtag</H3> |
---|
| 299 | <PRE> |
---|
| 300 | public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>calcEtag</B>(<A HREF="../../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A> solrReq)</PRE> |
---|
| 301 | <DL> |
---|
| 302 | <DD>Calculates a tag for the ETag header. |
---|
| 303 | <P> |
---|
| 304 | <DD><DL> |
---|
| 305 | <DT><B>Parameters:</B><DD><CODE>solrReq</CODE> - |
---|
| 306 | <DT><B>Returns:</B><DD>a tag</DL> |
---|
| 307 | </DD> |
---|
| 308 | </DL> |
---|
| 309 | <HR> |
---|
| 310 | |
---|
| 311 | <A NAME="isMatchingEtag(java.util.List, java.lang.String)"><!-- --></A><H3> |
---|
| 312 | isMatchingEtag</H3> |
---|
| 313 | <PRE> |
---|
| 314 | public static boolean <B>isMatchingEtag</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> headerList, |
---|
| 315 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> etag)</PRE> |
---|
| 316 | <DL> |
---|
| 317 | <DD>Checks if one of the tags in the list equals the given etag. |
---|
| 318 | <P> |
---|
| 319 | <DD><DL> |
---|
| 320 | <DT><B>Parameters:</B><DD><CODE>headerList</CODE> - the ETag header related header elements<DD><CODE>etag</CODE> - the ETag to compare with |
---|
| 321 | <DT><B>Returns:</B><DD>true if the etag is found in one of the header elements - false |
---|
| 322 | otherwise</DL> |
---|
| 323 | </DD> |
---|
| 324 | </DL> |
---|
| 325 | <HR> |
---|
| 326 | |
---|
| 327 | <A NAME="calcLastModified(org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3> |
---|
| 328 | calcLastModified</H3> |
---|
| 329 | <PRE> |
---|
| 330 | public static long <B>calcLastModified</B>(<A HREF="../../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A> solrReq)</PRE> |
---|
| 331 | <DL> |
---|
| 332 | <DD>Calculate the appropriate last-modified time for Solr relative the current request. |
---|
| 333 | <P> |
---|
| 334 | <DD><DL> |
---|
| 335 | <DT><B>Parameters:</B><DD><CODE>solrReq</CODE> - |
---|
| 336 | <DT><B>Returns:</B><DD>the timestamp to use as a last modified time.</DL> |
---|
| 337 | </DD> |
---|
| 338 | </DL> |
---|
| 339 | <HR> |
---|
| 340 | |
---|
| 341 | <A NAME="setCacheControlHeader(org.apache.solr.core.SolrConfig, javax.servlet.http.HttpServletResponse, org.apache.solr.servlet.cache.Method)"><!-- --></A><H3> |
---|
| 342 | setCacheControlHeader</H3> |
---|
| 343 | <PRE> |
---|
| 344 | public static void <B>setCacheControlHeader</B>(<A HREF="../../../../../org/apache/solr/core/SolrConfig.html" title="class in org.apache.solr.core">SolrConfig</A> conf, |
---|
| 345 | javax.servlet.http.HttpServletResponse resp, |
---|
| 346 | <A HREF="../../../../../org/apache/solr/servlet/cache/Method.html" title="enum in org.apache.solr.servlet.cache">Method</A> method)</PRE> |
---|
| 347 | <DL> |
---|
| 348 | <DD>Set the Cache-Control HTTP header (and Expires if needed) |
---|
| 349 | based on the SolrConfig. |
---|
| 350 | <P> |
---|
| 351 | <DD><DL> |
---|
| 352 | <DT><B>Parameters:</B><DD><CODE>conf</CODE> - The config of the SolrCore handling this request<DD><CODE>resp</CODE> - The servlet response object to modify<DD><CODE>method</CODE> - The request method (GET, POST, ...) used by this request</DL> |
---|
| 353 | </DD> |
---|
| 354 | </DL> |
---|
| 355 | <HR> |
---|
| 356 | |
---|
| 357 | <A NAME="doCacheHeaderValidation(org.apache.solr.request.SolrQueryRequest, javax.servlet.http.HttpServletRequest, org.apache.solr.servlet.cache.Method, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3> |
---|
| 358 | doCacheHeaderValidation</H3> |
---|
| 359 | <PRE> |
---|
| 360 | public static boolean <B>doCacheHeaderValidation</B>(<A HREF="../../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A> solrReq, |
---|
| 361 | javax.servlet.http.HttpServletRequest req, |
---|
| 362 | <A HREF="../../../../../org/apache/solr/servlet/cache/Method.html" title="enum in org.apache.solr.servlet.cache">Method</A> reqMethod, |
---|
| 363 | javax.servlet.http.HttpServletResponse resp) |
---|
| 364 | throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
---|
| 365 | <DL> |
---|
| 366 | <DD>Sets HTTP Response cache validator headers appropriately and |
---|
| 367 | validates the HTTP Request against these using any conditional |
---|
| 368 | request headers. |
---|
| 369 | |
---|
| 370 | If the request contains conditional headers, and those headers |
---|
| 371 | indicate a match with the current known state of the system, this |
---|
| 372 | method will return "true" indicating that a 304 Status code can be |
---|
| 373 | returned, and no further processing is needed. |
---|
| 374 | <P> |
---|
| 375 | <DD><DL> |
---|
| 376 | |
---|
| 377 | <DT><B>Returns:</B><DD>true if the request contains conditional headers, and those |
---|
| 378 | headers indicate a match with the current known state of the |
---|
| 379 | system -- indicating that a 304 Status code can be returned to |
---|
| 380 | the client, and no further request processing is needed. |
---|
| 381 | <DT><B>Throws:</B> |
---|
| 382 | <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
---|
| 383 | </DD> |
---|
| 384 | </DL> |
---|
| 385 | <HR> |
---|
| 386 | |
---|
| 387 | <A NAME="checkETagValidators(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.solr.servlet.cache.Method, java.lang.String)"><!-- --></A><H3> |
---|
| 388 | checkETagValidators</H3> |
---|
| 389 | <PRE> |
---|
| 390 | public static boolean <B>checkETagValidators</B>(javax.servlet.http.HttpServletRequest req, |
---|
| 391 | javax.servlet.http.HttpServletResponse resp, |
---|
| 392 | <A HREF="../../../../../org/apache/solr/servlet/cache/Method.html" title="enum in org.apache.solr.servlet.cache">Method</A> reqMethod, |
---|
| 393 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> etag) |
---|
| 394 | throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
---|
| 395 | <DL> |
---|
| 396 | <DD>Check for etag related conditional headers and set status |
---|
| 397 | <P> |
---|
| 398 | <DD><DL> |
---|
| 399 | |
---|
| 400 | <DT><B>Returns:</B><DD>true if no request processing is necessary and HTTP response status has been set, false otherwise. |
---|
| 401 | <DT><B>Throws:</B> |
---|
| 402 | <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
---|
| 403 | </DD> |
---|
| 404 | </DL> |
---|
| 405 | <HR> |
---|
| 406 | |
---|
| 407 | <A NAME="checkLastModValidators(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, long)"><!-- --></A><H3> |
---|
| 408 | checkLastModValidators</H3> |
---|
| 409 | <PRE> |
---|
| 410 | public static boolean <B>checkLastModValidators</B>(javax.servlet.http.HttpServletRequest req, |
---|
| 411 | javax.servlet.http.HttpServletResponse resp, |
---|
| 412 | long lastMod) |
---|
| 413 | throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
---|
| 414 | <DL> |
---|
| 415 | <DD>Check for modify time related conditional headers and set status |
---|
| 416 | <P> |
---|
| 417 | <DD><DL> |
---|
| 418 | |
---|
| 419 | <DT><B>Returns:</B><DD>true if no request processing is necessary and HTTP response status has been set, false otherwise. |
---|
| 420 | <DT><B>Throws:</B> |
---|
| 421 | <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
---|
| 422 | </DD> |
---|
| 423 | </DL> |
---|
| 424 | <HR> |
---|
| 425 | |
---|
| 426 | <A NAME="checkHttpCachingVeto(org.apache.solr.response.SolrQueryResponse, javax.servlet.http.HttpServletResponse, org.apache.solr.servlet.cache.Method)"><!-- --></A><H3> |
---|
| 427 | checkHttpCachingVeto</H3> |
---|
| 428 | <PRE> |
---|
| 429 | public static void <B>checkHttpCachingVeto</B>(<A HREF="../../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A> solrRsp, |
---|
| 430 | javax.servlet.http.HttpServletResponse resp, |
---|
| 431 | <A HREF="../../../../../org/apache/solr/servlet/cache/Method.html" title="enum in org.apache.solr.servlet.cache">Method</A> reqMethod)</PRE> |
---|
| 432 | <DL> |
---|
| 433 | <DD>Checks if the downstream request handler wants to avoid HTTP caching of |
---|
| 434 | the response. |
---|
| 435 | <P> |
---|
| 436 | <DD><DL> |
---|
| 437 | <DT><B>Parameters:</B><DD><CODE>solrRsp</CODE> - The Solr response object<DD><CODE>resp</CODE> - The HTTP servlet response object<DD><CODE>reqMethod</CODE> - The HTTP request type</DL> |
---|
| 438 | </DD> |
---|
| 439 | </DL> |
---|
| 440 | <!-- ========= END OF CLASS DATA ========= --> |
---|
| 441 | <HR> |
---|
| 442 | |
---|
| 443 | |
---|
| 444 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
| 445 | <A NAME="navbar_bottom"><!-- --></A> |
---|
| 446 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
| 447 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
| 448 | <TR> |
---|
| 449 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 450 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
| 451 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
| 452 | <TR ALIGN="center" VALIGN="top"> |
---|
| 453 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 454 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 455 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 456 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/HttpCacheHeaderUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 457 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 458 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 459 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 460 | </TR> |
---|
| 461 | </TABLE> |
---|
| 462 | </TD> |
---|
| 463 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 464 | </EM> |
---|
| 465 | </TD> |
---|
| 466 | </TR> |
---|
| 467 | |
---|
| 468 | <TR> |
---|
| 469 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 470 | PREV CLASS |
---|
| 471 | <A HREF="../../../../../org/apache/solr/servlet/cache/Method.html" title="enum in org.apache.solr.servlet.cache"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 472 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 473 | <A HREF="../../../../../index.html?org/apache/solr/servlet/cache/HttpCacheHeaderUtil.html" target="_top"><B>FRAMES</B></A> |
---|
| 474 | <A HREF="HttpCacheHeaderUtil.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 475 | <SCRIPT type="text/javascript"> |
---|
| 476 | <!-- |
---|
| 477 | if(window==top) { |
---|
| 478 | document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
| 479 | } |
---|
| 480 | //--> |
---|
| 481 | </SCRIPT> |
---|
| 482 | <NOSCRIPT> |
---|
| 483 | <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
| 484 | </NOSCRIPT> |
---|
| 485 | |
---|
| 486 | |
---|
| 487 | </FONT></TD> |
---|
| 488 | </TR> |
---|
| 489 | <TR> |
---|
| 490 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 491 | SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 492 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 493 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 494 | </TR> |
---|
| 495 | </TABLE> |
---|
| 496 | <A NAME="skip-navbar_bottom"></A> |
---|
| 497 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
| 498 | |
---|
| 499 | <HR> |
---|
| 500 | |
---|
| 501 | <address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address> |
---|
| 502 | <script src='../../../../../prettify.js' type='text/javascript'></script> |
---|
| 503 | <script type='text/javascript'> |
---|
| 504 | (function(){ |
---|
| 505 | var oldonload = window.onload; |
---|
| 506 | if (typeof oldonload != 'function') { |
---|
| 507 | window.onload = prettyPrint; |
---|
| 508 | } else { |
---|
| 509 | window.onload = function() { |
---|
| 510 | oldonload(); |
---|
| 511 | prettyPrint(); |
---|
| 512 | } |
---|
| 513 | } |
---|
| 514 | })(); |
---|
| 515 | </script> |
---|
| 516 | |
---|
| 517 | </BODY> |
---|
| 518 | </HTML> |
---|