juplo.de Git - website/blob - dist/http-resources/2.0.0/apidocs/de/juplo/httpresources/HttpResourceFetcher.html

   1 <!DOCTYPE HTML>
   2 <!-- NewPage -->
   3 <html lang="de">
   4 <head>
   5 <!-- Generated by javadoc (11.0.9.1) on Mon Jan 25 21:25:49 CET 2021 -->
   6 <title>HttpResourceFetcher (HttpResources 2.0.0 API)</title>
   7 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   8 <meta name="dc.created" content="2021-01-25">
   9 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  10 <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
  11 <script type="text/javascript" src="../../../script.js"></script>
  12 <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
  13 <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
  14 <!--[if IE]>
  15 <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
  16 <![endif]-->
  17 <script type="text/javascript" src="../../../jquery/jquery-3.5.1.js"></script>
  18 <script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
  19 </head>
  20 <body>
  21 <script type="text/javascript"><!--
  22     try {
  23         if (location.href.indexOf('is-external=true') == -1) {
  24             parent.document.title="HttpResourceFetcher (HttpResources 2.0.0 API)";
  25         }
  26     }
  27     catch(err) {
  28     }
  29 //-->
  30 var data = {"i0":10};
  31 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  32 var altColor = "altColor";
  33 var rowColor = "rowColor";
  34 var tableTab = "tableTab";
  35 var activeTableTab = "activeTableTab";
  36 var pathtoroot = "../../../";
  37 var useModuleDirectories = true;
  38 loadScripts(document, 'script');</script>
  39 <noscript>
  40 <div>JavaScript is disabled on your browser.</div>
  41 </noscript>
  42 <header role="banner">
  43 <nav role="navigation">
  44 <div class="fixedNav">
  45 <!-- ========= START OF TOP NAVBAR ======= -->
  46 <div class="topNav"><a id="navbar.top">
  47 <!--   -->
  48 </a>
  49 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  50 <a id="navbar.top.firstrow">
  51 <!--   -->
  52 </a>
  53 <ul class="navList" title="Navigation">
  54 <li><a href="package-summary.html">Package</a></li>
  55 <li class="navBarCell1Rev">Class</li>
  56 <li><a href="class-use/HttpResourceFetcher.html">Use</a></li>
  57 <li><a href="package-tree.html">Tree</a></li>
  58 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  59 <li><a href="../../../index-all.html">Index</a></li>
  60 <li><a href="../../../help-doc.html">Help</a></li>
  61 </ul>
  62 </div>
  63 <div class="subNav">
  64 <ul class="navList" id="allclasses_navbar_top">
  65 <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  66 </ul>
  67 <ul class="navListSearch">
  68 <li><label for="search">SEARCH:</label>
  69 <input type="text" id="search" value="search" disabled="disabled">
  70 <input type="reset" id="reset" value="reset" disabled="disabled">
  71 </li>
  72 </ul>
  73 <div>
  74 <script type="text/javascript"><!--
  75   allClassesLink = document.getElementById("allclasses_navbar_top");
  76   if(window==top) {
  77     allClassesLink.style.display = "block";
  78   }
  79   else {
  80     allClassesLink.style.display = "none";
  81   }
  82   //-->
  83 </script>
  84 <noscript>
  85 <div>JavaScript is disabled on your browser.</div>
  86 </noscript>
  87 </div>
  88 <div>
  89 <ul class="subNavList">
  90 <li>Summary:&nbsp;</li>
  91 <li>Nested&nbsp;|&nbsp;</li>
  92 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  93 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  94 <li><a href="#method.summary">Method</a></li>
  95 </ul>
  96 <ul class="subNavList">
  97 <li>Detail:&nbsp;</li>
  98 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  99 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 100 <li><a href="#method.detail">Method</a></li>
 101 </ul>
 102 </div>
 103 <a id="skip.navbar.top">
 104 <!--   -->
 105 </a></div>
 106 <!-- ========= END OF TOP NAVBAR ========= -->
 107 </div>
 108 <div class="navPadding">&nbsp;</div>
 109 <script type="text/javascript"><!--
 110 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 111 //-->
 112 </script>
 113 </nav>
 114 </header>
 115 <!-- ======== START OF CLASS DATA ======== -->
 116 <main role="main">
 117 <div class="header">
 118 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">de.juplo.httpresources</a></div>
 119 <h2 title="Class HttpResourceFetcher" class="title">Class HttpResourceFetcher</h2>
 120 </div>
 121 <div class="contentContainer">
 122 <ul class="inheritance">
 123 <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
 124 <li>
 125 <ul class="inheritance">
 126 <li>de.juplo.httpresources.HttpResourceFetcher</li>
 127 </ul>
 128 </li>
 129 </ul>
 130 <div class="description">
 131 <ul class="blockList">
 132 <li class="blockList">
 133 <hr>
 134 <pre>public class <span class="typeNameLabel">HttpResourceFetcher</span>
 135 extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
 136 </li>
 137 </ul>
 138 </div>
 139 <div class="summary">
 140 <ul class="blockList">
 141 <li class="blockList">
 142 <!-- =========== FIELD SUMMARY =========== -->
 143 <section role="region">
 144 <ul class="blockList">
 145 <li class="blockList"><a id="field.summary">
 146 <!--   -->
 147 </a>
 148 <h3>Field Summary</h3>
 149 <table class="memberSummary">
 150 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 151 <tr>
 152 <th class="colFirst" scope="col">Modifier and Type</th>
 153 <th class="colSecond" scope="col">Field</th>
 154 <th class="colLast" scope="col">Description</th>
 155 </tr>
 156 <tr class="altColor">
 157 <td class="colFirst"><code>static int</code></td>
 158 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_TTL">DEFAULT_TTL</a></span></code></th>
 159 <td class="colLast">&nbsp;</td>
 160 </tr>
 161 </table>
 162 </li>
 163 </ul>
 164 </section>
 165 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 166 <section role="region">
 167 <ul class="blockList">
 168 <li class="blockList"><a id="constructor.summary">
 169 <!--   -->
 170 </a>
 171 <h3>Constructor Summary</h3>
 172 <table class="memberSummary">
 173 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 174 <tr>
 175 <th class="colFirst" scope="col">Constructor</th>
 176 <th class="colLast" scope="col">Description</th>
 177 </tr>
 178 <tr class="altColor">
 179 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.springframework.http.client.ClientHttpRequestFactory,org.springframework.cache.Cache,java.time.Clock)">HttpResourceFetcher</a></span>&#8203;(org.springframework.http.client.ClientHttpRequestFactory&nbsp;factory,
 180                    org.springframework.cache.Cache&nbsp;cache,
 181                    <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Clock.html?is-external=true" title="class or interface in java.time" class="externalLink">Clock</a>&nbsp;clock)</code></th>
 182 <td class="colLast">&nbsp;</td>
 183 </tr>
 184 <tr class="rowColor">
 185 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.springframework.http.client.ClientHttpRequestFactory,org.springframework.cache.Cache,java.time.Clock,int,int,boolean)">HttpResourceFetcher</a></span>&#8203;(org.springframework.http.client.ClientHttpRequestFactory&nbsp;factory,
 186                    org.springframework.cache.Cache&nbsp;cache,
 187                    <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Clock.html?is-external=true" title="class or interface in java.time" class="externalLink">Clock</a>&nbsp;clock,
 188                    int&nbsp;defaultTTL,
 189                    int&nbsp;minTTL,
 190                    boolean&nbsp;serveStale)</code></th>
 191 <td class="colLast">&nbsp;</td>
 192 </tr>
 193 </table>
 194 </li>
 195 </ul>
 196 </section>
 197 <!-- ========== METHOD SUMMARY =========== -->
 198 <section role="region">
 199 <ul class="blockList">
 200 <li class="blockList"><a id="method.summary">
 201 <!--   -->
 202 </a>
 203 <h3>Method Summary</h3>
 204 <table class="memberSummary">
 205 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 206 <tr>
 207 <th class="colFirst" scope="col">Modifier and Type</th>
 208 <th class="colSecond" scope="col">Method</th>
 209 <th class="colLast" scope="col">Description</th>
 210 </tr>
 211 <tr id="i0" class="altColor">
 212 <td class="colFirst"><code>de.juplo.httpresources.HttpData</code></td>
 213 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetch(java.net.URI,de.juplo.httpresources.HttpData)">fetch</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;uri,
 214      de.juplo.httpresources.HttpData&nbsp;data)</code></th>
 215 <td class="colLast">
 216 <div class="block">Fetches the remote resource and reports, if it was modified.</div>
 217 </td>
 218 </tr>
 219 </table>
 220 <ul class="blockList">
 221 <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
 222 <!--   -->
 223 </a>
 224 <h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
 225 <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
 226 </ul>
 227 </li>
 228 </ul>
 229 </section>
 230 </li>
 231 </ul>
 232 </div>
 233 <div class="details">
 234 <ul class="blockList">
 235 <li class="blockList">
 236 <!-- ============ FIELD DETAIL =========== -->
 237 <section role="region">
 238 <ul class="blockList">
 239 <li class="blockList"><a id="field.detail">
 240 <!--   -->
 241 </a>
 242 <h3>Field Detail</h3>
 243 <a id="DEFAULT_TTL">
 244 <!--   -->
 245 </a>
 246 <ul class="blockListLast">
 247 <li class="blockList">
 248 <h4>DEFAULT_TTL</h4>
 249 <pre>public static final&nbsp;int DEFAULT_TTL</pre>
 250 <dl>
 251 <dt><span class="seeLabel">See Also:</span></dt>
 252 <dd><a href="../../../constant-values.html#de.juplo.httpresources.HttpResourceFetcher.DEFAULT_TTL">Constant Field Values</a></dd>
 253 </dl>
 254 </li>
 255 </ul>
 256 </li>
 257 </ul>
 258 </section>
 259 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 260 <section role="region">
 261 <ul class="blockList">
 262 <li class="blockList"><a id="constructor.detail">
 263 <!--   -->
 264 </a>
 265 <h3>Constructor Detail</h3>
 266 <a id="&lt;init&gt;(org.springframework.http.client.ClientHttpRequestFactory,org.springframework.cache.Cache,java.time.Clock)">
 267 <!--   -->
 268 </a>
 269 <ul class="blockList">
 270 <li class="blockList">
 271 <h4>HttpResourceFetcher</h4>
 272 <pre>public&nbsp;HttpResourceFetcher&#8203;(org.springframework.http.client.ClientHttpRequestFactory&nbsp;factory,
 273                            org.springframework.cache.Cache&nbsp;cache,
 274                            <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Clock.html?is-external=true" title="class or interface in java.time" class="externalLink">Clock</a>&nbsp;clock)</pre>
 275 </li>
 276 </ul>
 277 <a id="&lt;init&gt;(org.springframework.http.client.ClientHttpRequestFactory,org.springframework.cache.Cache,java.time.Clock,int,int,boolean)">
 278 <!--   -->
 279 </a>
 280 <ul class="blockListLast">
 281 <li class="blockList">
 282 <h4>HttpResourceFetcher</h4>
 283 <pre>public&nbsp;HttpResourceFetcher&#8203;(org.springframework.http.client.ClientHttpRequestFactory&nbsp;factory,
 284                            org.springframework.cache.Cache&nbsp;cache,
 285                            <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Clock.html?is-external=true" title="class or interface in java.time" class="externalLink">Clock</a>&nbsp;clock,
 286                            int&nbsp;defaultTTL,
 287                            int&nbsp;minTTL,
 288                            boolean&nbsp;serveStale)</pre>
 289 <dl>
 290 <dt><span class="paramLabel">Parameters:</span></dt>
 291 <dd><code>factory</code> - </dd>
 292 <dd><code>clock</code> - </dd>
 293 <dd><code>defaultTTL</code> - default time to live in milliseconds
 294  Default TTL, if no according information is present in the HTTP-headers.
 295  If set to <code>0</code>, caching will be disabled, if no according
 296  HTTP-headers are present.</dd>
 297 <dd><code>minTTL</code> - the minimum time to live, if caching is enabled
 298  A minimum TTL, that will overwrite the time to live, that was extracted
 299  from the HTTP-headers.
 300  The minimum TTL is only applied, if the default TTL is set to a value
 301  greater than zero, hence enabling caching by default.</dd>
 302 <dd><code>serveStale</code> - </dd>
 303 </dl>
 304 </li>
 305 </ul>
 306 </li>
 307 </ul>
 308 </section>
 309 <!-- ============ METHOD DETAIL ========== -->
 310 <section role="region">
 311 <ul class="blockList">
 312 <li class="blockList"><a id="method.detail">
 313 <!--   -->
 314 </a>
 315 <h3>Method Detail</h3>
 316 <a id="fetch(java.net.URI,de.juplo.httpresources.HttpData)">
 317 <!--   -->
 318 </a>
 319 <ul class="blockListLast">
 320 <li class="blockList">
 321 <h4>fetch</h4>
 322 <pre class="methodSignature">public&nbsp;de.juplo.httpresources.HttpData&nbsp;fetch&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;uri,
 323                                              de.juplo.httpresources.HttpData&nbsp;data)</pre>
 324 <div class="block">Fetches the remote resource and reports, if it was modified.
 325
 326  This method fetches the remote resource, if was not already fetched.
 327  If the resource was already fetched, it revalidates it, if necessary.</div>
 328 <dl>
 329 <dt><span class="returnLabel">Returns:</span></dt>
 330 <dd><code>true</code>, if the resource has changed or was fetched for
 331  the first time, otherwise <code>false</code></dd>
 332 </dl>
 333 </li>
 334 </ul>
 335 </li>
 336 </ul>
 337 </section>
 338 </li>
 339 </ul>
 340 </div>
 341 </div>
 342 </main>
 343 <!-- ========= END OF CLASS DATA ========= -->
 344 <footer role="contentinfo">
 345 <nav role="navigation">
 346 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 347 <div class="bottomNav"><a id="navbar.bottom">
 348 <!--   -->
 349 </a>
 350 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 351 <a id="navbar.bottom.firstrow">
 352 <!--   -->
 353 </a>
 354 <ul class="navList" title="Navigation">
 355 <li><a href="package-summary.html">Package</a></li>
 356 <li class="navBarCell1Rev">Class</li>
 357 <li><a href="class-use/HttpResourceFetcher.html">Use</a></li>
 358 <li><a href="package-tree.html">Tree</a></li>
 359 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 360 <li><a href="../../../index-all.html">Index</a></li>
 361 <li><a href="../../../help-doc.html">Help</a></li>
 362 </ul>
 363 </div>
 364 <div class="subNav">
 365 <ul class="navList" id="allclasses_navbar_bottom">
 366 <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
 367 </ul>
 368 <div>
 369 <script type="text/javascript"><!--
 370   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 371   if(window==top) {
 372     allClassesLink.style.display = "block";
 373   }
 374   else {
 375     allClassesLink.style.display = "none";
 376   }
 377   //-->
 378 </script>
 379 <noscript>
 380 <div>JavaScript is disabled on your browser.</div>
 381 </noscript>
 382 </div>
 383 <div>
 384 <ul class="subNavList">
 385 <li>Summary:&nbsp;</li>
 386 <li>Nested&nbsp;|&nbsp;</li>
 387 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 388 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 389 <li><a href="#method.summary">Method</a></li>
 390 </ul>
 391 <ul class="subNavList">
 392 <li>Detail:&nbsp;</li>
 393 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 394 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 395 <li><a href="#method.detail">Method</a></li>
 396 </ul>
 397 </div>
 398 <a id="skip.navbar.bottom">
 399 <!--   -->
 400 </a></div>
 401 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 402 </nav>
 403 <p class="legalCopy"><small>Copyright &#169; 2020&#x2013;2021 <a href="https://juplo.de">juplo</a>. All rights reserved.</small></p>
 404 </footer>
 405 </body>
 406 </html>