Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/CachedObject.html ============================================================================== --- websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/CachedObject.html (original) +++ websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/CachedObject.html Wed Aug 4 05:57:38 2021 @@ -1,207 +1,198 @@ -<!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>CachedObject xref</title> -<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/cache/CachedObject.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> <strong class="jxr_keyword">import</strong> java.io.Serializable; -<a name="23" href="#23">23</a> -<a name="24" href="#24">24</a> <em class="jxr_javadoccomment">/**</em> -<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * Wrapper for an object you want to store in a cache for a period of time.</em> -<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * </em> -<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Dave Bryson</a></em> -<a name="28" href="#28">28</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="29" href="#29">29</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Eric Pugh</a></em> -<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @version $Id: CachedObject.java 670326 2008-06-22 09:31:47Z tv $</em> -<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> */</em> -<a name="32" href="#32">32</a> -<a name="33" href="#33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a> implements Serializable -<a name="34" href="#34">34</a> { -<a name="35" href="#35">35</a> <em class="jxr_comment">/*</em> -<a name="36" href="#36">36</a> <em class="jxr_comment"> * TODO: The old Turbine version you could set the default age from Turbine.</em> -<a name="37" href="#37">37</a> <em class="jxr_comment"> * What we need is a CachedObjectFactory that would generate CachedObject's</em> -<a name="38" href="#38">38</a> <em class="jxr_comment"> * that could then have their default age set.</em> -<a name="39" href="#39">39</a> <em class="jxr_comment"> */</em> -<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 = -9107764093769042092L; -<a name="45" href="#45">45</a> -<a name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Cache the object with the Default TTL */</em> -<a name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT = 0; -<a name="48" href="#48">48</a> -<a name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Do not expire the object */</em> -<a name="50" href="#50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> FOREVER = -1; -<a name="51" href="#51">51</a> -<a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The object to be cached. */</em> -<a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> Object contents = <strong class="jxr_keyword">null</strong>; -<a name="54" href="#54">54</a> -<a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Default age (30 minutes). */</em> -<a name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> defaultage = 1800000; -<a name="57" href="#57">57</a> -<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> When created. * */</em> -<a name="59" href="#59">59</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> created = 0; -<a name="60" href="#60">60</a> -<a name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> When it expires. * */</em> -<a name="62" href="#62">62</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> expires = 0; -<a name="63" href="#63">63</a> -<a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Is this object stale/expired? */</em> -<a name="65" href="#65">65</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> stale = false; -<a name="66" href="#66">66</a> -<a name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em> -<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Constructor; sets the object to expire in the default time (30 minutes).</em> -<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * </em> -<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @param o</em> -<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * The object you want to cache.</em> -<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em> -<a name="73" href="#73">73</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a>(Object o) -<a name="74" href="#74">74</a> { -<a name="75" href="#75">75</a> <strong class="jxr_keyword">this</strong>.contents = o; -<a name="76" href="#76">76</a> <strong class="jxr_keyword">this</strong>.expires = <strong class="jxr_keyword">this</strong>.defaultage; -<a name="77" href="#77">77</a> <strong class="jxr_keyword">this</strong>.created = System.currentTimeMillis(); -<a name="78" href="#78">78</a> } -<a name="79" href="#79">79</a> -<a name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em> -<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * Constructor.</em> -<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * </em> -<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param o</em> -<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * The object to cache.</em> -<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @param expires</em> -<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * How long before the object expires, in ms, e.g. 1000 = 1</em> -<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * second.</em> -<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em> -<a name="89" href="#89">89</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a>(Object o, <strong class="jxr_keyword">long</strong> expires) -<a name="90" href="#90">90</a> { -<a name="91" href="#91">91</a> <strong class="jxr_keyword">if</strong> (expires == DEFAULT) -<a name="92" href="#92">92</a> { -<a name="93" href="#93">93</a> <strong class="jxr_keyword">this</strong>.expires = <strong class="jxr_keyword">this</strong>.defaultage; -<a name="94" href="#94">94</a> } -<a name="95" href="#95">95</a> -<a name="96" href="#96">96</a> <strong class="jxr_keyword">this</strong>.contents = o; -<a name="97" href="#97">97</a> <strong class="jxr_keyword">this</strong>.expires = expires; -<a name="98" href="#98">98</a> <strong class="jxr_keyword">this</strong>.created = System.currentTimeMillis(); -<a name="99" href="#99">99</a> } -<a name="100" href="#100">100</a> -<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">/**</em> -<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * Returns the cached object.</em> -<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * </em> -<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @return The cached object.</em> -<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em> -<a name="106" href="#106">106</a> <strong class="jxr_keyword">public</strong> Object getContents() -<a name="107" href="#107">107</a> { -<a name="108" href="#108">108</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.contents; -<a name="109" href="#109">109</a> } -<a name="110" href="#110">110</a> -<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">/**</em> -<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * Returns the creation time for the object.</em> -<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * </em> -<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * @return When the object was created.</em> -<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> */</em> -<a name="116" href="#116">116</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getCreated() -<a name="117" href="#117">117</a> { -<a name="118" href="#118">118</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.created; -<a name="119" href="#119">119</a> } -<a name="120" href="#120">120</a> -<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">/**</em> -<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * Returns the expiration time for the object.</em> -<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * </em> -<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @return When the object expires.</em> -<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> */</em> -<a name="126" href="#126">126</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getExpires() -<a name="127" href="#127">127</a> { -<a name="128" href="#128">128</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.expires; -<a name="129" href="#129">129</a> } -<a name="130" href="#130">130</a> -<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">/**</em> -<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * Set the expiration interval for the object.</em> -<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * </em> -<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * @param expires</em> -<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * Expiration interval in millis ( 1 second = 1000 millis)</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> setExpires(<strong class="jxr_keyword">long</strong> expires) -<a name="138" href="#138">138</a> { -<a name="139" href="#139">139</a> <strong class="jxr_keyword">if</strong> (expires == DEFAULT) -<a name="140" href="#140">140</a> { -<a name="141" href="#141">141</a> <strong class="jxr_keyword">this</strong>.expires = <strong class="jxr_keyword">this</strong>.defaultage; -<a name="142" href="#142">142</a> } -<a name="143" href="#143">143</a> <strong class="jxr_keyword">else</strong> -<a name="144" href="#144">144</a> { -<a name="145" href="#145">145</a> <strong class="jxr_keyword">this</strong>.expires = expires; -<a name="146" href="#146">146</a> } -<a name="147" href="#147">147</a> <strong class="jxr_keyword">if</strong> (expires == FOREVER) -<a name="148" href="#148">148</a> { -<a name="149" href="#149">149</a> setStale(false); -<a name="150" href="#150">150</a> } -<a name="151" href="#151">151</a> <strong class="jxr_keyword">else</strong> -<a name="152" href="#152">152</a> { -<a name="153" href="#153">153</a> setStale((System.currentTimeMillis() - <strong class="jxr_keyword">this</strong>.created) > expires); -<a name="154" href="#154">154</a> } -<a name="155" href="#155">155</a> } -<a name="156" href="#156">156</a> -<a name="157" href="#157">157</a> <em class="jxr_javadoccomment">/**</em> -<a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * Set the stale status for the object.</em> -<a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * </em> -<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @param stale</em> -<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * Whether the object is stale or not.</em> -<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> */</em> -<a name="163" href="#163">163</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> setStale(<strong class="jxr_keyword">boolean</strong> stale) -<a name="164" href="#164">164</a> { -<a name="165" href="#165">165</a> <strong class="jxr_keyword">this</strong>.stale = stale; -<a name="166" href="#166">166</a> } -<a name="167" href="#167">167</a> -<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">/**</em> -<a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * Get the stale status for the object.</em> -<a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * </em> -<a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * @return Whether the object is stale or not.</em> -<a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> */</em> -<a name="173" href="#173">173</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">boolean</strong> getStale() -<a name="174" href="#174">174</a> { -<a name="175" href="#175">175</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.stale; -<a name="176" href="#176">176</a> } -<a name="177" href="#177">177</a> -<a name="178" href="#178">178</a> <em class="jxr_javadoccomment">/**</em> -<a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * Is the object stale?</em> -<a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * </em> -<a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * @return True if the object is stale.</em> -<a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> */</em> -<a name="183" href="#183">183</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">boolean</strong> isStale() -<a name="184" href="#184">184</a> { -<a name="185" href="#185">185</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.expires == FOREVER) -<a name="186" href="#186">186</a> { -<a name="187" href="#187">187</a> <strong class="jxr_keyword">return</strong> false; -<a name="188" href="#188">188</a> } -<a name="189" href="#189">189</a> -<a name="190" href="#190">190</a> setStale((System.currentTimeMillis() - <strong class="jxr_keyword">this</strong>.created) > <strong class="jxr_keyword">this</strong>.expires); -<a name="191" href="#191">191</a> <strong class="jxr_keyword">return</strong> getStale(); -<a name="192" href="#192">192</a> } -<a name="193" href="#193">193</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>CachedObject xref</title> +<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/cache/CachedObject.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> <strong class="jxr_keyword">import</strong> java.io.Serializable; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.atomic.AtomicBoolean; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * Wrapper for an object you want to store in a cache for a period of time.</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Dave Bryson</a></em> +<a class="jxr_linenumber" name="L29" href="#L29">29</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="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Eric Pugh</a></em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * @version $Id: CachedObject.java 1890338 2021-05-31 10:31:19Z gk $</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> CachedObject<T> <strong class="jxr_keyword">implements</strong> Serializable +<a class="jxr_linenumber" name="L35" href="#L35">35</a> { +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_comment"> * TODO: The old Turbine version you could set the default age from Turbine.</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_comment"> * What we need is a CachedObjectFactory that would generate CachedObject's</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_comment"> * that could then have their default age set.</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * Serialization key</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</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 = -9107764093769042092L; +<a class="jxr_linenumber" name="L46" href="#L46">46</a> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/** Cache the object with the Default TTL */</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT = 0; +<a class="jxr_linenumber" name="L49" href="#L49">49</a> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/** Do not expire the object */</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> FOREVER = -1; +<a class="jxr_linenumber" name="L52" href="#L52">52</a> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment">/** The object to be cached. */</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> T contents = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L55" href="#L55">55</a> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/** Default age (30 minutes). */</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</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> DEFAULT_AGE = 1_800_000; +<a class="jxr_linenumber" name="L58" href="#L58">58</a> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment">/** When the object is created. */</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> created; +<a class="jxr_linenumber" name="L61" href="#L61">61</a> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment">/** When the object should expire. */</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> expires; +<a class="jxr_linenumber" name="L64" href="#L64">64</a> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/** Is this object stale/expired? */</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> AtomicBoolean stale = <strong class="jxr_keyword">new</strong> AtomicBoolean(); +<a class="jxr_linenumber" name="L67" href="#L67">67</a> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * Constructor; sets the object to expire in the default time (30 minutes).</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @param object</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * The object you want to cache.</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">public</strong> <a name="CachedObject" href="../../../../org/apache/fulcrum/cache/CachedObject.html#CachedObject">CachedObject</a>(<strong class="jxr_keyword">final</strong> T object) +<a class="jxr_linenumber" name="L75" href="#L75">75</a> { +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">this</strong>(object, DEFAULT); +<a class="jxr_linenumber" name="L77" href="#L77">77</a> } +<a class="jxr_linenumber" name="L78" href="#L78">78</a> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * Constructor.</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * @param object</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * The object to cache.</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * @param expires</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * How long before the object expires, in ms, e.g. 1000 = 1</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * second.</em> +<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> <strong class="jxr_keyword">public</strong> <a name="CachedObject" href="../../../../org/apache/fulcrum/cache/CachedObject.html#CachedObject">CachedObject</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="L89" href="#L89">89</a> { +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">if</strong> (expires == DEFAULT) +<a class="jxr_linenumber" name="L91" href="#L91">91</a> { +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">this</strong>.expires = <strong class="jxr_keyword">this</strong>.DEFAULT_AGE; +<a class="jxr_linenumber" name="L93" href="#L93">93</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">this</strong>.expires = expires; +<a class="jxr_linenumber" name="L95" href="#L95">95</a> } +<a class="jxr_linenumber" name="L96" href="#L96">96</a> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">this</strong>.contents = object; +<a class="jxr_linenumber" name="L98" href="#L98">98</a> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">this</strong>.created = System.currentTimeMillis(); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> } +<a class="jxr_linenumber" name="L101" href="#L101">101</a> +<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"> * Returns the cached object.</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> <em class="jxr_javadoccomment"> * @return The cached object.</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">public</strong> T getContents() +<a class="jxr_linenumber" name="L108" href="#L108">108</a> { +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.contents; +<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"> * Returns the creation time for the object.</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> <em class="jxr_javadoccomment"> * @return When the object was created.</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getCreated() +<a class="jxr_linenumber" name="L118" href="#L118">118</a> { +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.created; +<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 the expiration time for the object.</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @return When the object expires.</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getExpires() +<a class="jxr_linenumber" name="L128" href="#L128">128</a> { +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.expires; +<a class="jxr_linenumber" name="L130" href="#L130">130</a> } +<a class="jxr_linenumber" name="L131" href="#L131">131</a> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * Set the expiration interval for the object.</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @param expires</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * Expiration interval in millis ( 1 second = 1000 millis)</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setExpires(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> expires) +<a class="jxr_linenumber" name="L139" href="#L139">139</a> { +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">if</strong> (expires == DEFAULT) +<a class="jxr_linenumber" name="L141" href="#L141">141</a> { +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">this</strong>.expires = <strong class="jxr_keyword">this</strong>.DEFAULT_AGE; +<a class="jxr_linenumber" name="L143" href="#L143">143</a> } +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> { +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">this</strong>.expires = expires; +<a class="jxr_linenumber" name="L147" href="#L147">147</a> } +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">if</strong> (expires == FOREVER) +<a class="jxr_linenumber" name="L149" href="#L149">149</a> { +<a class="jxr_linenumber" name="L150" href="#L150">150</a> setStale(false); +<a class="jxr_linenumber" name="L151" href="#L151">151</a> } +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> { +<a class="jxr_linenumber" name="L154" href="#L154">154</a> setStale((System.currentTimeMillis() - <strong class="jxr_keyword">this</strong>.created) > expires); +<a class="jxr_linenumber" name="L155" href="#L155">155</a> } +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * Set the stale status for the object.</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @param stale</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * Whether the object is stale or not.</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setStale(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> stale) +<a class="jxr_linenumber" name="L165" href="#L165">165</a> { +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">this</strong>.stale.set( stale ); +<a class="jxr_linenumber" name="L167" href="#L167">167</a> } +<a class="jxr_linenumber" name="L168" href="#L168">168</a> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * Is the object stale?</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * @return True if the object is stale.</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isStale() +<a class="jxr_linenumber" name="L176" href="#L176">176</a> { +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">boolean</strong> currentState = false; +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.expires != FOREVER) +<a class="jxr_linenumber" name="L179" href="#L179">179</a> { +<a class="jxr_linenumber" name="L180" href="#L180">180</a> setStale((System.currentTimeMillis() - <strong class="jxr_keyword">this</strong>.created) > <strong class="jxr_keyword">this</strong>.expires); +<a class="jxr_linenumber" name="L181" href="#L181">181</a> currentState = <strong class="jxr_keyword">this</strong>.stale.get(); +<a class="jxr_linenumber" name="L182" href="#L182">182</a> } +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">return</strong> currentState; +<a class="jxr_linenumber" name="L184" href="#L184">184</a> } +<a class="jxr_linenumber" name="L185" href="#L185">185</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
Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/GlobalCacheService.html ============================================================================== --- websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/GlobalCacheService.html (original) +++ websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/GlobalCacheService.html Wed Aug 4 05:57:38 2021 @@ -1,117 +1,117 @@ -<!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>GlobalCacheService xref</title> -<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/cache/GlobalCacheService.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> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a name="24" href="#24">24</a> -<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.component.Component; -<a name="26" href="#26">26</a> -<a name="27" href="#27">27</a> <em class="jxr_javadoccomment">/**</em> -<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * GlobalCacheService interface.</em> -<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * </em> -<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Dave Bryson</a></em> -<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Peter Courcoux</a></em> -<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * @version $Id: GlobalCacheService.java 927153 2010-03-24 18:55:08Z tv $</em> -<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> */</em> -<a name="34" href="#34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/fulcrum/cache/GlobalCacheService.html">GlobalCacheService</a> <strong class="jxr_keyword">extends</strong> Component -<a name="35" href="#35">35</a> { -<a name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Avalon role - used to id the component within the manager */</em> -<a name="37" href="#37">37</a> String ROLE = GlobalCacheService.<strong class="jxr_keyword">class</strong>.getName(); -<a name="38" href="#38">38</a> -<a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em> -<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Gets a cached object given its id (a String).</em> -<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * </em> -<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @param id</em> -<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * The String id for the object.</em> -<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @return A CachedObject.</em> -<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @exception ObjectExpiredException,</em> -<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * if the object has expired in the cache.</em> -<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> */</em> -<a name="48" href="#48">48</a> <a href="../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a> getObject(String id) <strong class="jxr_keyword">throws</strong> ObjectExpiredException; -<a name="49" href="#49">49</a> -<a name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em> -<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Adds an object to the cache.</em> -<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * </em> -<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @param id</em> -<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * The String id for the object.</em> -<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @param o</em> -<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * The object to add to the cache.</em> -<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> -<a name="58" href="#58">58</a> <strong class="jxr_keyword">void</strong> addObject(String id, <a href="../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a> o); -<a name="59" href="#59">59</a> -<a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em> -<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Removes an object from the cache.</em> -<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * </em> -<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @param id</em> -<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * The String id for the object.</em> -<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> -<a name="66" href="#66">66</a> <strong class="jxr_keyword">void</strong> removeObject(String id); -<a name="67" href="#67">67</a> -<a name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em> -<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Returns a copy of keys to objects in the cache as a list.</em> -<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * </em> -<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * Note that keys to expired objects are not returned.</em> -<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * </em> -<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @return A List of <code>String</code>'s representing the keys to</em> -<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * objects in the cache.</em> -<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> -<a name="76" href="#76">76</a> <strong class="jxr_keyword">public</strong> List getKeys(); -<a name="77" href="#77">77</a> -<a name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em> -<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * Returns a copy of the non-expired CachedObjects in the cache as a list.</em> -<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * </em> -<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * @return A List of <code>CachedObject</code> objects held in the cache</em> -<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em> -<a name="83" href="#83">83</a> <strong class="jxr_keyword">public</strong> List getCachedObjects(); -<a name="84" href="#84">84</a> -<a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em> -<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Returns the current size of the cache.</em> -<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * </em> -<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @return int representing current cache size in number of bytes</em> -<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> */</em> -<a name="90" href="#90">90</a> <strong class="jxr_keyword">int</strong> getCacheSize() <strong class="jxr_keyword">throws</strong> IOException; -<a name="91" href="#91">91</a> -<a name="92" href="#92">92</a> <em class="jxr_javadoccomment">/**</em> -<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * Returns the number of objects in the cache.</em> -<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * </em> -<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * @return int The current number of objects in the cache.</em> -<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> */</em> -<a name="97" href="#97">97</a> <strong class="jxr_keyword">int</strong> getNumberOfObjects(); -<a name="98" href="#98">98</a> -<a name="99" href="#99">99</a> <em class="jxr_javadoccomment">/**</em> -<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * Flush the cache of all objects.</em> -<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> */</em> -<a name="102" href="#102">102</a> <strong class="jxr_keyword">void</strong> flushCache(); -<a name="103" href="#103">103</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>GlobalCacheService xref</title> +<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/cache/GlobalCacheService.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> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * GlobalCacheService interface.</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Dave Bryson</a></em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Peter CourefreshableCachedObjectux</a></em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * @version $Id: GlobalCacheService.java 1890075 2021-05-21 15:04:52Z painter $</em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a name="GlobalCacheService" href="../../../../org/apache/fulcrum/cache/GlobalCacheService.html#GlobalCacheService">GlobalCacheService</a> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> { +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/** Avalon role - used to id the component within the manager */</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> String ROLE = GlobalCacheService.<strong class="jxr_keyword">class</strong>.getName(); +<a class="jxr_linenumber" name="L36" href="#L36">36</a> +<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> <em class="jxr_javadoccomment"> * Gets a cached object given its id (a String).</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * @param <T> type of object to return</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @param objectId</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * The String id for the object.</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @return A CachedObject.</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @throws ObjectExpiredException</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * if the object has expired in the cache.</em> +<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> <T> CachedObject<T> getObject(String objectId) <strong class="jxr_keyword">throws</strong> ObjectExpiredException; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> +<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"> * Adds an object to the cache.</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"> * @param <T> type of object to add</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @param objectId</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * The String id for the object.</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * @param object</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * The object to add to 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> <T> <strong class="jxr_keyword">void</strong> addObject(String objectId, CachedObject<T> object); +<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"> * Removes an object from the cache.</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 objectId</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * The String id for the object.</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">void</strong> removeObject(String objectId); +<a class="jxr_linenumber" name="L67" href="#L67">67</a> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * Returns a copy of keys to objects in the cache as a list.</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * Note that keys to expired objects are not returned.</em> +<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"> * @return A List of <code>String</code>'s representing the keys to</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * objects in the cache.</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> List<String> getKeys(); +<a class="jxr_linenumber" name="L77" href="#L77">77</a> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * Returns a copy of the non-expired CachedObjects in the cache as a list.</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> <em class="jxr_javadoccomment"> * @return A List of <code>CachedObject</code> objects held in the cache</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> List<CachedObject<?>> getCachedObjects(); +<a class="jxr_linenumber" name="L84" href="#L84">84</a> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * Returns the current size of the cache.</em> +<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"> * @return int representing current cache size in number of bytes</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * @throws IOException if unable to return cache size</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">int</strong> getCacheSize() <strong class="jxr_keyword">throws</strong> IOException; +<a class="jxr_linenumber" name="L92" href="#L92">92</a> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * Returns the number of objects in the cache.</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @return int The current number of objects in the cache.</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">int</strong> getNumberOfObjects(); +<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"> * Flush the cache of all objects.</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> <strong class="jxr_keyword">void</strong> flushCache(); +<a class="jxr_linenumber" name="L104" href="#L104">104</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 Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/ObjectExpiredException.html ============================================================================== --- websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/ObjectExpiredException.html (original) +++ websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/ObjectExpiredException.html Wed Aug 4 05:57:38 2021 @@ -1,50 +1,49 @@ -<!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>ObjectExpiredException xref</title> -<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/cache/ObjectExpiredException.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"> * Exception thrown when an item either does not exist or has expired from the</em> -<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * GlobalCache.</em> -<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * </em> -<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Dave Bryson</a></em> -<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * @version $Id: ObjectExpiredException.java 670326 2008-06-22 09:31:47Z tv $</em> -<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> */</em> -<a name="29" href="#29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/fulcrum/cache/ObjectExpiredException.html">ObjectExpiredException</a> <strong class="jxr_keyword">extends</strong> Exception -<a name="30" href="#30">30</a> { -<a name="31" href="#31">31</a> -<a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em> -<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * Serial version id</em> -<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> */</em> -<a name="35" href="#35">35</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 = -4331535517388875678L; -<a name="36" href="#36">36</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>ObjectExpiredException xref</title> +<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/cache/ObjectExpiredException.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"> * Exception thrown when an item either does not exist or has expired from the</em> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * GlobalCache.</em> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Dave Bryson</a></em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * @version $Id: ObjectExpiredException.java 670326 2008-06-22 09:31:47Z tv $</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="ObjectExpiredException" href="../../../../org/apache/fulcrum/cache/ObjectExpiredException.html#ObjectExpiredException">ObjectExpiredException</a> <strong class="jxr_keyword">extends</strong> Exception +<a class="jxr_linenumber" name="L30" href="#L30">30</a> { +<a class="jxr_linenumber" name="L31" href="#L31">31</a> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * Serial version id</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</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 = -4331535517388875678L; +<a class="jxr_linenumber" name="L36" href="#L36">36</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 Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/Refreshable.html ============================================================================== --- websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/Refreshable.html (original) +++ websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/Refreshable.html Wed Aug 4 05:57:38 2021 @@ -1,49 +1,48 @@ -<!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>Refreshable xref</title> -<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/cache/Refreshable.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"> * This is the interface for objects you want to refresh themselves from the</em> -<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * cache.</em> -<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * </em> -<a name="26" href="#26">26</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="27" href="#27">27</a> <em class="jxr_javadoccomment"> * @version $Id: Refreshable.java 670326 2008-06-22 09:31:47Z tv $</em> -<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> */</em> -<a name="29" href="#29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/fulcrum/cache/Refreshable.html">Refreshable</a> -<a name="30" href="#30">30</a> { -<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em> -<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Refreshes the object.</em> -<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> */</em> -<a name="34" href="#34">34</a> <strong class="jxr_keyword">void</strong> refresh(); -<a name="35" href="#35">35</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>Refreshable xref</title> +<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/cache/Refreshable.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"> * This is the interface for objects you want to refresh themselves from the</em> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * cache.</em> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L26" href="#L26">26</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="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * @version $Id: Refreshable.java 670326 2008-06-22 09:31:47Z tv $</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a name="Refreshable" href="../../../../org/apache/fulcrum/cache/Refreshable.html#Refreshable">Refreshable</a> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> { +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * Refreshes the object.</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> <strong class="jxr_keyword">void</strong> refresh(); +<a class="jxr_linenumber" name="L35" href="#L35">35</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
