Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/RefreshableCachedObject.html ============================================================================== --- websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/RefreshableCachedObject.html (original) +++ websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/RefreshableCachedObject.html Wed Aug 4 05:57:38 2021 @@ -1,160 +1,175 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> -<head> -<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> -<title>RefreshableCachedObject xref</title> -<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/cache/RefreshableCachedObject.html">View Javadoc</a></div><pre> - -<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.fulcrum.cache; -<a name="2" href="#2">2</a> -<a name="3" href="#3">3</a> <em class="jxr_comment">/*</em> -<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> -<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> -<a name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> -<a name="13" href="#13">13</a> <em class="jxr_comment"> *</em> -<a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em> -<a name="20" href="#20">20</a> <em class="jxr_comment"> */</em> -<a name="21" href="#21">21</a> -<a name="22" href="#22">22</a> <em class="jxr_javadoccomment">/**</em> -<a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * The idea of the RefreshableCachedObject is that, rather than removing items</em> -<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * from the cache when they become stale, we'll tell them to refresh themselves</em> -<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * instead. That way they'll always be in the cache, and the code to refresh</em> -<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * them will be run by the background thread rather than by a user request</em> -<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * thread. You can also set a TTL (Time To Live) for the object. This way, if</em> -<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * the object hasn't been touched for the TTL period, then it will be removed</em> -<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * from the cache.</em> -<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * </em> -<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * This extends CachedObject and provides a method for refreshing the cached</em> -<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * object, and resetting its expire time.</em> -<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * </em> -<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Nissim Karpenstein</a></em> -<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Henning P. Schmiedehausen</a></em> -<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @version $Id: RefreshableCachedObject.java 670326 2008-06-22 09:31:47Z tv $</em> -<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> */</em> -<a name="38" href="#38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html">RefreshableCachedObject</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a> -<a name="39" href="#39">39</a> { -<a name="40" href="#40">40</a> -<a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em> -<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Serialization key</em> -<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em> -<a name="44" href="#44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 4072572956381768087L; -<a name="45" href="#45">45</a> -<a name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em> -<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * How long to wait before removing an untouched object from the cache.</em> -<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * Negative numbers mean never remove (the default).</em> -<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em> -<a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> timeToLive = -1; -<a name="51" href="#51">51</a> -<a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em> -<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * The last time the Object was accessed from the cache.</em> -<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> */</em> -<a name="55" href="#55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> lastAccess; -<a name="56" href="#56">56</a> -<a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em> -<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Constructor; sets the object to expire in the default time (30 minutes).</em> -<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * </em> -<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @param o</em> -<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * The object you want to cache.</em> -<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em> -<a name="63" href="#63">63</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html">RefreshableCachedObject</a>(<a href="../../../../org/apache/fulcrum/cache/Refreshable.html">Refreshable</a> o) -<a name="64" href="#64">64</a> { -<a name="65" href="#65">65</a> <strong class="jxr_keyword">super</strong>(o); -<a name="66" href="#66">66</a> <strong class="jxr_keyword">this</strong>.lastAccess = System.currentTimeMillis(); -<a name="67" href="#67">67</a> } -<a name="68" href="#68">68</a> -<a name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em> -<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * Constructor.</em> -<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * </em> -<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @param o</em> -<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * The object to cache.</em> -<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @param expires</em> -<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * How long before the object expires, in ms, e.g. 1000 = 1</em> -<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * second.</em> -<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> */</em> -<a name="78" href="#78">78</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html">RefreshableCachedObject</a>(<a href="../../../../org/apache/fulcrum/cache/Refreshable.html">Refreshable</a> o, <strong class="jxr_keyword">long</strong> expires) -<a name="79" href="#79">79</a> { -<a name="80" href="#80">80</a> <strong class="jxr_keyword">super</strong>(o, expires); -<a name="81" href="#81">81</a> <strong class="jxr_keyword">this</strong>.lastAccess = System.currentTimeMillis(); -<a name="82" href="#82">82</a> } -<a name="83" href="#83">83</a> -<a name="84" href="#84">84</a> <em class="jxr_javadoccomment">/**</em> -<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * Sets the timeToLive value</em> -<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * </em> -<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @param timeToLive</em> -<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * the new Value in milliseconds</em> -<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> */</em> -<a name="90" href="#90">90</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> setTTL(<strong class="jxr_keyword">long</strong> timeToLive) -<a name="91" href="#91">91</a> { -<a name="92" href="#92">92</a> <strong class="jxr_keyword">this</strong>.timeToLive = timeToLive; -<a name="93" href="#93">93</a> } -<a name="94" href="#94">94</a> -<a name="95" href="#95">95</a> <em class="jxr_javadoccomment">/**</em> -<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * Gets the timeToLive value.</em> -<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * </em> -<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @return The current timeToLive value (in milliseconds)</em> -<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em> -<a name="100" href="#100">100</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">long</strong> getTTL() -<a name="101" href="#101">101</a> { -<a name="102" href="#102">102</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.timeToLive; -<a name="103" href="#103">103</a> } -<a name="104" href="#104">104</a> -<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">/**</em> -<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * Sets the last access time to the current time.</em> -<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> */</em> -<a name="108" href="#108">108</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> touch() -<a name="109" href="#109">109</a> { -<a name="110" href="#110">110</a> <strong class="jxr_keyword">this</strong>.lastAccess = System.currentTimeMillis(); -<a name="111" href="#111">111</a> } -<a name="112" href="#112">112</a> -<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">/**</em> -<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * Returns true if the object hasn't been touched in the previous TTL</em> -<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * period.</em> -<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> */</em> -<a name="117" href="#117">117</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">boolean</strong> isUntouched() -<a name="118" href="#118">118</a> { -<a name="119" href="#119">119</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.timeToLive < 0) -<a name="120" href="#120">120</a> { -<a name="121" href="#121">121</a> <strong class="jxr_keyword">return</strong> false; -<a name="122" href="#122">122</a> } -<a name="123" href="#123">123</a> -<a name="124" href="#124">124</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.lastAccess + <strong class="jxr_keyword">this</strong>.timeToLive < System.currentTimeMillis()) -<a name="125" href="#125">125</a> { -<a name="126" href="#126">126</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; -<a name="127" href="#127">127</a> } -<a name="128" href="#128">128</a> <strong class="jxr_keyword">else</strong> -<a name="129" href="#129">129</a> { -<a name="130" href="#130">130</a> <strong class="jxr_keyword">return</strong> false; -<a name="131" href="#131">131</a> } -<a name="132" href="#132">132</a> } -<a name="133" href="#133">133</a> -<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">/**</em> -<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * Refresh the object and the created time.</em> -<a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> */</em> -<a name="137" href="#137">137</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> refresh() -<a name="138" href="#138">138</a> { -<a name="139" href="#139">139</a> <a href="../../../../org/apache/fulcrum/cache/Refreshable.html">Refreshable</a> r = (Refreshable) getContents(); -<a name="140" href="#140">140</a> <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>) -<a name="141" href="#141">141</a> { -<a name="142" href="#142">142</a> <strong class="jxr_keyword">this</strong>.created = System.currentTimeMillis(); -<a name="143" href="#143">143</a> r.refresh(); -<a name="144" href="#144">144</a> } -<a name="145" href="#145">145</a> } -<a name="146" href="#146">146</a> } -</pre> -<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> -</html> - +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> +<title>RefreshableCachedObject xref</title> +<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/cache/RefreshableCachedObject.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.fulcrum.cache; +<a class="jxr_linenumber" name="L2" href="#L2">2</a> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> * The idea of the RefreshableCachedObject is that, rather than removing items</em> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * from the cache when they become stale, we'll tell them to refresh themselves</em> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * instead. That way they'll always be in the cache, and the code to refresh</em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * them will be run by the background thread rather than by a user request</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * thread. You can also set a TTL (Time To Live) for the object. This way, if</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * the object hasn't been touched for the TTL period, then it will be removed</em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * from the cache.</em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * This extends CachedObject and provides a method for refreshing the cached</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * object, and resetting its expire time.</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Nissim Karpenstein</a></em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Henning P. Schmiedehausen</a></em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * @version $Id: RefreshableCachedObject.java 1890338 2021-05-31 10:31:19Z gk $</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> RefreshableCachedObject<T <strong class="jxr_keyword">extends</strong> Refreshable> <strong class="jxr_keyword">extends</strong> CachedObject<T> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> { +<a class="jxr_linenumber" name="L40" href="#L40">40</a> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * Serialization key</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 4072572956381768087L; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * How long to wait before removing an untouched object from the cache.</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * Negative numbers mean never remove (the default).</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * time to live in millisec, getter/setter ({@link #getTTL()}</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> timeToLive = -1; +<a class="jxr_linenumber" name="L54" href="#L54">54</a> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * The last time the Object was accessed from the cache.</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> lastAccess; +<a class="jxr_linenumber" name="L59" href="#L59">59</a> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Constructor; sets the object to expire in the default time (30 minutes).</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @param object</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * The object you want to cache.</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">public</strong> <a name="RefreshableCachedObject" href="../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html#RefreshableCachedObject">RefreshableCachedObject</a>(<strong class="jxr_keyword">final</strong> T object) +<a class="jxr_linenumber" name="L67" href="#L67">67</a> { +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">super</strong>(object); +<a class="jxr_linenumber" name="L69" href="#L69">69</a> setLastAccess(System.currentTimeMillis()); +<a class="jxr_linenumber" name="L70" href="#L70">70</a> } +<a class="jxr_linenumber" name="L71" href="#L71">71</a> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * Constructor.</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @param object</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * The object to cache.</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * @param expires</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * How long before the object expires, in ms, e.g. 1000 = 1</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * second.</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">public</strong> <a name="RefreshableCachedObject" href="../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html#RefreshableCachedObject">RefreshableCachedObject</a>(<strong class="jxr_keyword">final</strong> T object, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> expires) +<a class="jxr_linenumber" name="L82" href="#L82">82</a> { +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">super</strong>(object, expires); +<a class="jxr_linenumber" name="L84" href="#L84">84</a> setLastAccess(System.currentTimeMillis()); +<a class="jxr_linenumber" name="L85" href="#L85">85</a> } +<a class="jxr_linenumber" name="L86" href="#L86">86</a> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * Sets the timeToLive value</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * @param timeToLive</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * the new Value in milliseconds</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTTL(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> timeToLive) +<a class="jxr_linenumber" name="L94" href="#L94">94</a> { +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">synchronized</strong>(<strong class="jxr_keyword">this</strong>) { +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">this</strong>.timeToLive = timeToLive; +<a class="jxr_linenumber" name="L97" href="#L97">97</a> } +<a class="jxr_linenumber" name="L98" href="#L98">98</a> } +<a class="jxr_linenumber" name="L99" href="#L99">99</a> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * Gets the timeToLive value.</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @return The current timeToLive value (in milliseconds)</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getTTL() +<a class="jxr_linenumber" name="L106" href="#L106">106</a> { +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">synchronized</strong>(<strong class="jxr_keyword">this</strong>) { +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.timeToLive; +<a class="jxr_linenumber" name="L109" href="#L109">109</a> } +<a class="jxr_linenumber" name="L110" href="#L110">110</a> } +<a class="jxr_linenumber" name="L111" href="#L111">111</a> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * Sets the last access time to the current time.</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> touch() +<a class="jxr_linenumber" name="L116" href="#L116">116</a> { +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">synchronized</strong>(<strong class="jxr_keyword">this</strong>) { +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">this</strong>.lastAccess = System.currentTimeMillis(); +<a class="jxr_linenumber" name="L119" href="#L119">119</a> } +<a class="jxr_linenumber" name="L120" href="#L120">120</a> } +<a class="jxr_linenumber" name="L121" href="#L121">121</a> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * Returns true if the object hasn't been touched in the previous TTL</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * period.</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @return boolean status of object</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isUntouched() +<a class="jxr_linenumber" name="L129" href="#L129">129</a> { +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">boolean</strong> untouched = false; +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">synchronized</strong>(<strong class="jxr_keyword">this</strong>) { +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.lastAccess + <strong class="jxr_keyword">this</strong>.timeToLive < System.currentTimeMillis()) +<a class="jxr_linenumber" name="L133" href="#L133">133</a> { +<a class="jxr_linenumber" name="L134" href="#L134">134</a> untouched = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L135" href="#L135">135</a> } +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">return</strong> untouched; +<a class="jxr_linenumber" name="L137" href="#L137">137</a> } +<a class="jxr_linenumber" name="L138" href="#L138">138</a> } +<a class="jxr_linenumber" name="L139" href="#L139">139</a> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * Refresh the object and the created time.</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> refresh() +<a class="jxr_linenumber" name="L144" href="#L144">144</a> { +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">final</strong> <a name="Refreshable" href="../../../../org/apache/fulcrum/cache/Refreshable.html#Refreshable">Refreshable</a> refreshable = getContents(); +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>) +<a class="jxr_linenumber" name="L147" href="#L147">147</a> { +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">this</strong>.created = System.currentTimeMillis(); +<a class="jxr_linenumber" name="L149" href="#L149">149</a> refreshable.refresh(); +<a class="jxr_linenumber" name="L150" href="#L150">150</a> } +<a class="jxr_linenumber" name="L151" href="#L151">151</a> } +<a class="jxr_linenumber" name="L152" href="#L152">152</a> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getLastAccess() +<a class="jxr_linenumber" name="L154" href="#L154">154</a> { +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">return</strong> lastAccess; +<a class="jxr_linenumber" name="L156" href="#L156">156</a> } +<a class="jxr_linenumber" name="L157" href="#L157">157</a> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLastAccess(<strong class="jxr_keyword">long</strong> lastAccess) +<a class="jxr_linenumber" name="L159" href="#L159">159</a> { +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">this</strong>.lastAccess = lastAccess; +<a class="jxr_linenumber" name="L161" href="#L161">161</a> } +<a class="jxr_linenumber" name="L162" href="#L162">162</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2004–2021 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> \ No newline at end of file
