+++ /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::DDL::AgentDDL</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::DDL::AgentDDL</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/ddl/agentddl_rb.html">
- lib/mcollective/ddl/agentddl.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A <a href="../DDL.html">DDL</a> class specific to agent plugins.
-</p>
-<p>
-A full <a href="../DDL.html">DDL</a> can be seen below with all the
-possible bells and whistles present.
-</p>
-<p>
-metadata :name => "Utilities and Helpers for SimpleRPC <a
-href="../Agents.html">Agents</a>",
-</p>
-<pre>
- :description => "General helpful actions that expose stats and internals to SimpleRPC clients",
- :author => "R.I.Pienaar <rip@devco.net>",
- :license => "Apache License, Version 2.0",
- :version => "1.0",
- :url => "http://marionette-collective.org/",
- :timeout => 10
-</pre>
-<p>
-<a href="AgentDDL.html#M000183">action</a> "get_fact",
-:description => "Retrieve a single fact from the fact store"
-do
-</p>
-<pre>
- display :always
-
- input :fact,
- :prompt => "The name of the fact",
- :description => "The fact to retrieve",
- :type => :string,
- :validation => '^[\w\-\.]+$',
- :optional => false,
- :maxlength => 40,
- :default => "fqdn"
-
- output :fact,
- :description => "The name of the fact being returned",
- :display_as => "Fact"
-
- output :value,
- :description => "The value of the fact",
- :display_as => "Value",
- :default => ""
-
- summarize do
- aggregate summary(:value)
- end
-</pre>
-<p>
-end
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000183">action</a>
- <a href="#M000188">action_interface</a>
- <a href="#M000189">actions</a>
- <a href="#M000181">aggregate</a>
- <a href="#M000182">display</a>
- <a href="#M000179">input</a>
- <a href="#M000185">is_function?</a>
- <a href="#M000184">method_missing</a>
- <a href="#M000178">new</a>
- <a href="#M000186">set_default_input_arguments</a>
- <a href="#M000180">summarize</a>
- <a href="#M000187">validate_rpc_request</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-M000178" class="method-detail">
- <a name="M000178"></a>
-
- <div class="method-heading">
- <a href="#M000178" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(plugin, plugintype=:agent, loadddl=true)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000178-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000178-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 41</span>
-41: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">plugin</span>, <span class="ruby-identifier">plugintype</span>=<span class="ruby-identifier">:agent</span>, <span class="ruby-identifier">loadddl</span>=<span class="ruby-keyword kw">true</span>)
-42: <span class="ruby-ivar">@process_aggregate_functions</span> = <span class="ruby-keyword kw">nil</span>
-43:
-44: <span class="ruby-keyword kw">super</span>
-45: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000183" class="method-detail">
- <a name="M000183"></a>
-
- <div class="method-heading">
- <a href="#M000183" class="method-signature">
- <span class="method-name">action</span><span class="method-args">(name, input, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates the definition for an <a href="AgentDDL.html#M000183">action</a>,
-you can nest <a href="AgentDDL.html#M000179">input</a> definitions inside
-the <a href="AgentDDL.html#M000183">action</a> to attach inputs and
-validation to the <a href="AgentDDL.html#M000189">actions</a>
-</p>
-<pre>
- action "status", :description => "Restarts a Service" do
- display :always
-
- input "service",
- :prompt => "Service Action",
- :description => "The action to perform",
- :type => :list,
- :optional => true,
- :list => ["start", "stop", "restart", "status"]
-
- output "status",
- :description => "The status of the service after the action"
-
- end
-</pre>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000183-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000183-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 112</span>
-112: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">action</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">input</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-113: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Action needs a :description property"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:description</span>)
-114:
-115: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@entities</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">name</span>)
-116: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>] = {}
-117: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:action</span>] = <span class="ruby-identifier">name</span>
-118: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:input</span>] = {}
-119: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:output</span>] = {}
-120: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:display</span>] = <span class="ruby-identifier">:failed</span>
-121: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:description</span>] = <span class="ruby-identifier">input</span>[<span class="ruby-identifier">:description</span>]
-122: <span class="ruby-keyword kw">end</span>
-123:
-124: <span class="ruby-comment cmt"># if a block is passed it might be creating input methods, call it</span>
-125: <span class="ruby-comment cmt"># we set @current_entity so the input block can know what its talking</span>
-126: <span class="ruby-comment cmt"># to, this is probably an epic hack, need to improve.</span>
-127: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-identifier">name</span>
-128: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-129: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-keyword kw">nil</span>
-130: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000188" class="method-detail">
- <a name="M000188"></a>
-
- <div class="method-heading">
- <a href="#M000188" class="method-signature">
- <span class="method-name">action_interface</span><span class="method-args">(name)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns the interface for a specific <a
-href="AgentDDL.html#M000183">action</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000188-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000188-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 198</span>
-198: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">action_interface</span>(<span class="ruby-identifier">name</span>)
-199: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>] <span class="ruby-operator">||</span> {}
-200: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000189" class="method-detail">
- <a name="M000189"></a>
-
- <div class="method-heading">
- <a href="#M000189" class="method-signature">
- <span class="method-name">actions</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns an array of <a href="AgentDDL.html#M000189">actions</a> this agent
-support
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000189-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000189-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 203</span>
-203: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">actions</span>
-204: <span class="ruby-ivar">@entities</span>.<span class="ruby-identifier">keys</span>
-205: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000181" class="method-detail">
- <a name="M000181"></a>
-
- <div class="method-heading">
- <a href="#M000181" class="method-signature">
- <span class="method-name">aggregate</span><span class="method-args">(function, format = {:format => nil})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets the <a href="AgentDDL.html#M000181">aggregate</a> array for the given
-<a href="AgentDDL.html#M000183">action</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000181-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000181-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 70</span>
-70: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">aggregate</span>(<span class="ruby-identifier">function</span>, <span class="ruby-identifier">format</span> = {<span class="ruby-identifier">:format</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>})
-71: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC28</span>, <span class="ruby-value str">"Formats supplied to aggregation functions should be a hash"</span>, <span class="ruby-identifier">:error</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">format</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
-72: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC27</span>, <span class="ruby-value str">"Formats supplied to aggregation functions must have a :format key"</span>, <span class="ruby-identifier">:error</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">format</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:format</span>)
-73: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC26</span>, <span class="ruby-value str">"Functions supplied to aggregate should be a hash"</span>, <span class="ruby-identifier">:error</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">function</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
-74:
-75: <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">function</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:args</span>)) <span class="ruby-operator">&&</span> <span class="ruby-identifier">function</span>[<span class="ruby-identifier">:args</span>]
-76: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC25</span>, <span class="ruby-value str">"aggregate method for action '%{action}' missing a function parameter"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">entities</span>[<span class="ruby-ivar">@current_entity</span>][<span class="ruby-identifier">:action</span>])
-77: <span class="ruby-keyword kw">end</span>
-78:
-79: <span class="ruby-identifier">entities</span>[<span class="ruby-ivar">@current_entity</span>][<span class="ruby-identifier">:aggregate</span>] <span class="ruby-operator">||=</span> []
-80: <span class="ruby-identifier">entities</span>[<span class="ruby-ivar">@current_entity</span>][<span class="ruby-identifier">:aggregate</span>] <span class="ruby-operator"><<</span> (<span class="ruby-identifier">format</span>[<span class="ruby-identifier">:format</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-value">? </span><span class="ruby-identifier">function</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">function</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">format</span>))
-81: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000182" class="method-detail">
- <a name="M000182"></a>
-
- <div class="method-heading">
- <a href="#M000182" class="method-signature">
- <span class="method-name">display</span><span class="method-args">(pref)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets the <a href="AgentDDL.html#M000182">display</a> preference to either
-:ok, :failed, :flatten or :always operates on <a
-href="AgentDDL.html#M000183">action</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000182-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000182-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 85</span>
-85: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">display</span>(<span class="ruby-identifier">pref</span>)
-86: <span class="ruby-comment cmt"># defaults to old behavior, complain if its supplied and invalid</span>
-87: <span class="ruby-keyword kw">unless</span> [<span class="ruby-identifier">:ok</span>, <span class="ruby-identifier">:failed</span>, <span class="ruby-identifier">:flatten</span>, <span class="ruby-identifier">:always</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">pref</span>)
-88: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Display preference #{pref} is not valid, should be :ok, :failed, :flatten or :always"</span>
-89: <span class="ruby-keyword kw">end</span>
-90:
-91: <span class="ruby-identifier">action</span> = <span class="ruby-ivar">@current_entity</span>
-92: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">action</span>][<span class="ruby-identifier">:display</span>] = <span class="ruby-identifier">pref</span>
-93: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000179" class="method-detail">
- <a name="M000179"></a>
-
- <div class="method-heading">
- <a href="#M000179" class="method-signature">
- <span class="method-name">input</span><span class="method-args">(argument, properties)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000179-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000179-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 47</span>
-47: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">input</span>(<span class="ruby-identifier">argument</span>, <span class="ruby-identifier">properties</span>)
-48: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Input needs a :optional property"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">properties</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:optional</span>)
-49:
-50: <span class="ruby-keyword kw">super</span>
-51: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000185" class="method-detail">
- <a name="M000185"></a>
-
- <div class="method-heading">
- <a href="#M000185" class="method-signature">
- <span class="method-name">is_function?</span><span class="method-args">(method_name)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Checks if a method name matches a <a
-href="AgentDDL.html#M000181">aggregate</a> plugin. This is used by method
-missing so that we dont greedily assume that every <a
-href="AgentDDL.html#M000184">method_missing</a> call in an agent ddl has
-hit a <a href="AgentDDL.html#M000181">aggregate</a> function.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000185-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000185-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 146</span>
-146: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">is_function?</span>(<span class="ruby-identifier">method_name</span>)
-147: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find</span>(<span class="ruby-value str">"aggregate"</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">method_name</span>.<span class="ruby-identifier">to_s</span>)
-148: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000184" class="method-detail">
- <a name="M000184"></a>
-
- <div class="method-heading">
- <a href="#M000184" class="method-signature">
- <span class="method-name">method_missing</span><span class="method-args">(name, *args, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-If the method name matches a # <a
-href="AgentDDL.html#M000181">aggregate</a> function, we return the function
-with args as a hash. This will only be active if the
-@process_aggregate_functions is set to true which only happens in the <a
-href="AgentDDL.html#M000180">summarize</a> block
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000184-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000184-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 135</span>
-135: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-136: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@process_aggregate_functions</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">is_function?</span>(<span class="ruby-identifier">name</span>)
-137: <span class="ruby-identifier">raise</span> <span class="ruby-constant">NoMethodError</span>, <span class="ruby-node">"undefined local variable or method `#{name}'"</span>, <span class="ruby-identifier">caller</span>
-138: <span class="ruby-keyword kw">end</span>
-139:
-140: <span class="ruby-keyword kw">return</span> {<span class="ruby-identifier">:function</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">:args</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">args</span>}
-141: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000186" class="method-detail">
- <a name="M000186"></a>
-
- <div class="method-heading">
- <a href="#M000186" class="method-signature">
- <span class="method-name">set_default_input_arguments</span><span class="method-args">(action, arguments)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-For a given <a href="AgentDDL.html#M000183">action</a> and arguments look
-up the <a href="../DDL.html">DDL</a> interface to that <a
-href="AgentDDL.html#M000183">action</a> and if any arguments in the <a
-href="../DDL.html">DDL</a> have a :default value assign that to any <a
-href="AgentDDL.html#M000179">input</a> that does not have an argument in
-the <a href="AgentDDL.html#M000179">input</a> arguments
-</p>
-<p>
-This is intended to only be called on clients and not on servers as the
-clients should never be able to publish non compliant requests and the
-servers should really not tamper with incoming requests since doing so
-might raise validation errors that were not raised on the client breaking
-our fail-fast approach to <a href="AgentDDL.html#M000179">input</a>
-validation
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000186-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000186-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 159</span>
-159: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_default_input_arguments</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">arguments</span>)
-160: <span class="ruby-identifier">input</span> = <span class="ruby-identifier">action_interface</span>(<span class="ruby-identifier">action</span>)[<span class="ruby-identifier">:input</span>]
-161:
-162: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>
-163:
-164: <span class="ruby-identifier">input</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
-165: <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:default</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:optional</span>]
-166: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Setting default value for input '%s' to '%s'"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">key</span>, <span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:default</span>]])
-167: <span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:default</span>]
-168: <span class="ruby-keyword kw">end</span>
-169: <span class="ruby-keyword kw">end</span>
-170: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000180" class="method-detail">
- <a name="M000180"></a>
-
- <div class="method-heading">
- <a href="#M000180" class="method-signature">
- <span class="method-name">summarize</span><span class="method-args">(&block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Calls the <a href="AgentDDL.html#M000180">summarize</a> block defined in
-the ddl. Block will not be called if the ddl is getting processed on the
-server side. This means that <a href="AgentDDL.html#M000181">aggregate</a>
-plugins only have to be present on the client side.
-</p>
-<p>
-The @process_aggregate_functions variable is used by the <a
-href="AgentDDL.html#M000184">method_missing</a> block to determine if it
-should kick in, this way we very tightly control where we activate the <a
-href="AgentDDL.html#M000184">method_missing</a> behavior turning it into a
-noop otherwise to maximise the chance of providing good user feedback
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000180-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000180-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 61</span>
-61: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">summarize</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-62: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">mode</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:server</span>
-63: <span class="ruby-ivar">@process_aggregate_functions</span> = <span class="ruby-keyword kw">true</span>
-64: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>
-65: <span class="ruby-ivar">@process_aggregate_functions</span> = <span class="ruby-keyword kw">nil</span>
-66: <span class="ruby-keyword kw">end</span>
-67: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000187" class="method-detail">
- <a name="M000187"></a>
-
- <div class="method-heading">
- <a href="#M000187" class="method-signature">
- <span class="method-name">validate_rpc_request</span><span class="method-args">(action, arguments)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Helper to use the <a href="../DDL.html">DDL</a> to figure out if the remote
-call to an agent should be allowed based on <a
-href="AgentDDL.html#M000183">action</a> name and inputs.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000187-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000187-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 174</span>
-174: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_rpc_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">arguments</span>)
-175: <span class="ruby-comment cmt"># is the action known?</span>
-176: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">actions</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">action</span>)
-177: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC29</span>, <span class="ruby-value str">"Attempted to call action %{action} for %{plugin} but it's not declared in the DDL"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">action</span>, <span class="ruby-identifier">:plugin</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@pluginname</span>)
-178: <span class="ruby-keyword kw">end</span>
-179:
-180: <span class="ruby-identifier">input</span> = <span class="ruby-identifier">action_interface</span>(<span class="ruby-identifier">action</span>)[<span class="ruby-identifier">:input</span>] <span class="ruby-operator">||</span> {}
-181:
-182: <span class="ruby-identifier">input</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
-183: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:optional</span>]
-184: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
-185: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC30</span>, <span class="ruby-value str">"Action '%{action}' needs a '%{key}' argument"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">action</span>, <span class="ruby-identifier">:key</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>)
-186: <span class="ruby-keyword kw">end</span>
-187: <span class="ruby-keyword kw">end</span>
-188:
-189: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
-190: <span class="ruby-identifier">validate_input_argument</span>(<span class="ruby-identifier">input</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">key</span>])
-191: <span class="ruby-keyword kw">end</span>
-192: <span class="ruby-keyword kw">end</span>
-193:
-194: <span class="ruby-keyword kw">true</span>
-195: <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