--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!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>
+ <title>Class: MCollective::Facts::Base</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Class</strong></td>
+ <td class="class-name-in-header">MCollective::Facts::Base</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../../files/lib/mcollective/facts/base_rb.html">
+ lib/mcollective/facts/base.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ <tr class="top-aligned-row">
+ <td><strong>Parent:</strong></td>
+ <td>
+ Object
+ </td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+A base class for fact providers, to make a <a
+href="Base.html#M000019">new</a> fully functional fact provider inherit
+from this and simply provide a self.get_facts method that returns a hash
+like:
+</p>
+<pre>
+ {"foo" => "bar",
+ "bar" => "baz"}
+</pre>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000024">force_reload?</a>
+ <a href="#M000021">get_fact</a>
+ <a href="#M000022">get_facts</a>
+ <a href="#M000023">has_fact?</a>
+ <a href="#M000020">inherited</a>
+ <a href="#M000019">new</a>
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Class methods</h3>
+
+ <div id="method-M000020" class="method-detail">
+ <a name="M000020"></a>
+
+ <div class="method-heading">
+ <a href="#M000020" class="method-signature">
+ <span class="method-name">inherited</span><span class="method-args">(klass)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Registers <a href="Base.html#M000019">new</a> fact sources into the plugin
+manager
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000020-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 17</span>
+17: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
+18: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"facts_plugin"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>}
+19: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000019" class="method-detail">
+ <a name="M000019"></a>
+
+ <div class="method-heading">
+ <a href="#M000019" class="method-signature">
+ <span class="method-name">new</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000019-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 10</span>
+10: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+11: <span class="ruby-ivar">@facts</span> = {}
+12: <span class="ruby-ivar">@last_good_facts</span> = {}
+13: <span class="ruby-ivar">@last_facts_load</span> = <span class="ruby-value">0</span>
+14: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000024" class="method-detail">
+ <a name="M000024"></a>
+
+ <div class="method-heading">
+ <a href="#M000024" class="method-signature">
+ <span class="method-name">force_reload?</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Plugins can override this to provide forced fact invalidation
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000024-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 81</span>
+81: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">force_reload?</span>
+82: <span class="ruby-keyword kw">false</span>
+83: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000021" class="method-detail">
+ <a name="M000021"></a>
+
+ <div class="method-heading">
+ <a href="#M000021" class="method-signature">
+ <span class="method-name">get_fact</span><span class="method-args">(fact=nil)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns the value of a single fact
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000021-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 22</span>
+22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>=<span class="ruby-keyword kw">nil</span>)
+23: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
+24:
+25: <span class="ruby-identifier">cache_time</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">fact_cache_time</span> <span class="ruby-operator">||</span> <span class="ruby-value">300</span>
+26:
+27: <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">exclusive</span> <span class="ruby-keyword kw">do</span>
+28: <span class="ruby-keyword kw">begin</span>
+29: <span class="ruby-keyword kw">if</span> (<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@last_facts_load</span> <span class="ruby-operator">></span> <span class="ruby-identifier">cache_time</span>.<span class="ruby-identifier">to_i</span> ) <span class="ruby-operator">||</span> <span class="ruby-identifier">force_reload?</span>
+30: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Resetting facter cache, now: #{Time.now.to_i} last-known-good: #{@last_facts_load}"</span>)
+31:
+32: <span class="ruby-identifier">tfacts</span> = <span class="ruby-identifier">load_facts_from_source</span>
+33:
+34: <span class="ruby-comment cmt"># Force reset to last known good state on empty facts</span>
+35: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Got empty facts"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">tfacts</span>.<span class="ruby-identifier">empty?</span>
+36:
+37: <span class="ruby-ivar">@facts</span>.<span class="ruby-identifier">clear</span>
+38:
+39: <span class="ruby-identifier">tfacts</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>,<span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
+40: <span class="ruby-ivar">@facts</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">to_s</span>
+41: <span class="ruby-keyword kw">end</span>
+42:
+43: <span class="ruby-ivar">@last_good_facts</span> = <span class="ruby-ivar">@facts</span>.<span class="ruby-identifier">clone</span>
+44: <span class="ruby-ivar">@last_facts_load</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>
+45: <span class="ruby-keyword kw">else</span>
+46: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Using cached facts now: #{Time.now.to_i} last-known-good: #{@last_facts_load}"</span>)
+47: <span class="ruby-keyword kw">end</span>
+48: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+49: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Failed to load facts: #{e.class}: #{e}"</span>)
+50:
+51: <span class="ruby-comment cmt"># Avoid loops where failing fact loads cause huge CPU</span>
+52: <span class="ruby-comment cmt"># loops, this way it only retries once every cache_time</span>
+53: <span class="ruby-comment cmt"># seconds</span>
+54: <span class="ruby-ivar">@last_facts_load</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>
+55:
+56: <span class="ruby-comment cmt"># Revert to last known good state</span>
+57: <span class="ruby-ivar">@facts</span> = <span class="ruby-ivar">@last_good_facts</span>.<span class="ruby-identifier">clone</span>
+58: <span class="ruby-keyword kw">end</span>
+59: <span class="ruby-keyword kw">end</span>
+60:
+61:
+62: <span class="ruby-comment cmt"># If you do not supply a specific fact all facts will be returned</span>
+63: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">fact</span>.<span class="ruby-identifier">nil?</span>
+64: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@facts</span>
+65: <span class="ruby-keyword kw">else</span>
+66: <span class="ruby-ivar">@facts</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">fact</span>) <span class="ruby-operator">?</span> <span class="ruby-ivar">@facts</span>[<span class="ruby-identifier">fact</span>] <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>
+67: <span class="ruby-keyword kw">end</span>
+68: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000022" class="method-detail">
+ <a name="M000022"></a>
+
+ <div class="method-heading">
+ <a href="#M000022" class="method-signature">
+ <span class="method-name">get_facts</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns all facts
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000022-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 71</span>
+71: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_facts</span>
+72: <span class="ruby-identifier">get_fact</span>(<span class="ruby-keyword kw">nil</span>)
+73: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000023" class="method-detail">
+ <a name="M000023"></a>
+
+ <div class="method-heading">
+ <a href="#M000023" class="method-signature">
+ <span class="method-name">has_fact?</span><span class="method-args">(fact)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns true if we know about a specific fact, false otherwise
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000023-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 76</span>
+76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_fact?</span>(<span class="ruby-identifier">fact</span>)
+77: <span class="ruby-identifier">get_fact</span>(<span class="ruby-keyword kw">nil</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">fact</span>)
+78: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
\ No newline at end of file
Code Review / packages / precise / mcollective.git / blobdiff