1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8 <title>Class: MCollective::PluginPackager::AgentDefinition</title>
10 <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
12 <script src="../../js/jquery.js" type="text/javascript"
13 charset="utf-8"></script>
14 <script src="../../js/thickbox-compressed.js" type="text/javascript"
15 charset="utf-8"></script>
16 <script src="../../js/quicksearch.js" type="text/javascript"
17 charset="utf-8"></script>
18 <script src="../../js/darkfish.js" type="text/javascript"
19 charset="utf-8"></script>
25 <div id="file-metadata">
26 <div id="file-list-section" class="section">
27 <h3 class="section-header">In Files</h3>
28 <div class="section-body">
31 <li><a href="../../lib/mcollective/pluginpackager/agent_definition_rb.html?TB_iframe=true&height=550&width=785"
32 class="thickbox" title="lib/mcollective/pluginpackager/agent_definition.rb">lib/mcollective/pluginpackager/agent_definition.rb</a></li>
41 <div id="class-metadata">
45 <div id="parent-class-section" class="section">
46 <h3 class="section-header">Parent</h3>
48 <p class="link"><a href="../../Object.html">Object</a></p>
53 <!-- Namespace Contents -->
56 <!-- Method Quickref -->
58 <div id="method-list-section" class="section">
59 <h3 class="section-header">Methods</h3>
60 <ul class="link-list">
62 <li><a href="#M000090">::new</a></li>
64 <li><a href="#M000097">#agent</a></li>
66 <li><a href="#M000099">#client</a></li>
68 <li><a href="#M000100">#common</a></li>
70 <li><a href="#M000094">#identify_packages</a></li>
76 <!-- Included Modules -->
80 <div id="project-metadata">
83 <div id="fileindex-section" class="section project-section">
84 <h3 class="section-header">Files</h3>
87 <li class="file"><a href="../../COPYING.html">COPYING</a></li>
89 <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
91 <li class="file"><a href="../../README.html">README</a></li>
93 <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
95 <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
97 <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
99 <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
101 <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
103 <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
105 <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
107 <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
109 <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
111 <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
113 <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
115 <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
117 <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
119 <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
121 <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
123 <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
125 <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
131 <div id="classindex-section" class="section project-section">
132 <h3 class="section-header">Class Index
133 <span class="search-toggle"><img src="../../images/find.png"
134 height="16" width="16" alt="[+]"
135 title="show/hide quicksearch" /></span></h3>
136 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
138 <legend>Quicksearch</legend>
139 <input type="text" name="quicksearch" value=""
140 class="quicksearch-field" />
144 <ul class="link-list">
146 <li><a href="../../MCollective.html">MCollective</a></li>
148 <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
150 <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
152 <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
154 <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
156 <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
158 <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
160 <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
162 <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
164 <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
166 <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
168 <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
170 <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
172 <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
174 <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
176 <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
178 <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
180 <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
182 <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
184 <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
186 <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
188 <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
190 <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
192 <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
194 <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
196 <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
198 <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
200 <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
202 <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
204 <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
206 <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
208 <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
210 <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
212 <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
214 <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
216 <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
218 <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
220 <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
222 <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
224 <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
226 <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
228 <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
230 <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
232 <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
234 <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
236 <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
238 <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
240 <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
242 <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
244 <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
246 <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
248 <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
250 <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
252 <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
254 <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
256 <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
258 <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
260 <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
262 <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
264 <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
266 <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
268 <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
270 <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
272 <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
274 <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
276 <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
278 <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
280 <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
282 <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
284 <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
286 <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
288 <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
290 <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
292 <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
294 <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
296 <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
298 <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
300 <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
302 <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
304 <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
306 <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
308 <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
310 <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
312 <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
314 <li><a href="../../Array.html">Array</a></li>
316 <li><a href="../../Dir.html">Dir</a></li>
318 <li><a href="../../Object.html">Object</a></li>
320 <li><a href="../../String.html">String</a></li>
322 <li><a href="../../Symbol.html">Symbol</a></li>
325 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
332 <div id="documentation">
333 <h1 class="class">MCollective::PluginPackager::AgentDefinition</h1>
335 <div id="description">
337 <a href="../../MCollective.html">MCollective</a> <a
338 href="../Agent.html">Agent</a> Plugin package
348 <div id="attribute-method-details" class="method-section section">
349 <h3 class="section-header">Attributes</h3>
352 <div id="path-attribute-method" class="method-detail">
357 <div class="method-heading attribute-method-heading">
358 <span class="method-name">path</span><span
359 class="attribute-access-type">[RW]</span>
362 <div class="method-description">
364 <p class="missing-docs">(Not documented)</p>
369 <div id="packagedata-attribute-method" class="method-detail">
370 <a name="packagedata"></a>
372 <a name="packagedata="></a>
374 <div class="method-heading attribute-method-heading">
375 <span class="method-name">packagedata</span><span
376 class="attribute-access-type">[RW]</span>
379 <div class="method-description">
381 <p class="missing-docs">(Not documented)</p>
386 <div id="metadata-attribute-method" class="method-detail">
387 <a name="metadata"></a>
389 <a name="metadata="></a>
391 <div class="method-heading attribute-method-heading">
392 <span class="method-name">metadata</span><span
393 class="attribute-access-type">[RW]</span>
396 <div class="method-description">
398 <p class="missing-docs">(Not documented)</p>
403 <div id="target-path-attribute-method" class="method-detail">
404 <a name="target_path"></a>
406 <a name="target_path="></a>
408 <div class="method-heading attribute-method-heading">
409 <span class="method-name">target_path</span><span
410 class="attribute-access-type">[RW]</span>
413 <div class="method-description">
415 <p class="missing-docs">(Not documented)</p>
420 <div id="vendor-attribute-method" class="method-detail">
421 <a name="vendor"></a>
423 <a name="vendor="></a>
425 <div class="method-heading attribute-method-heading">
426 <span class="method-name">vendor</span><span
427 class="attribute-access-type">[RW]</span>
430 <div class="method-description">
432 <p class="missing-docs">(Not documented)</p>
437 <div id="revision-attribute-method" class="method-detail">
438 <a name="revision"></a>
440 <a name="revision="></a>
442 <div class="method-heading attribute-method-heading">
443 <span class="method-name">revision</span><span
444 class="attribute-access-type">[RW]</span>
447 <div class="method-description">
449 <p class="missing-docs">(Not documented)</p>
454 <div id="preinstall-attribute-method" class="method-detail">
455 <a name="preinstall"></a>
457 <a name="preinstall="></a>
459 <div class="method-heading attribute-method-heading">
460 <span class="method-name">preinstall</span><span
461 class="attribute-access-type">[RW]</span>
464 <div class="method-description">
466 <p class="missing-docs">(Not documented)</p>
471 <div id="plugintype-attribute-method" class="method-detail">
472 <a name="plugintype"></a>
474 <a name="plugintype="></a>
476 <div class="method-heading attribute-method-heading">
477 <span class="method-name">plugintype</span><span
478 class="attribute-access-type">[RW]</span>
481 <div class="method-description">
483 <p class="missing-docs">(Not documented)</p>
488 <div id="dependencies-attribute-method" class="method-detail">
489 <a name="dependencies"></a>
491 <a name="dependencies="></a>
493 <div class="method-heading attribute-method-heading">
494 <span class="method-name">dependencies</span><span
495 class="attribute-access-type">[RW]</span>
498 <div class="method-description">
500 <p class="missing-docs">(Not documented)</p>
505 <div id="postinstall-attribute-method" class="method-detail">
506 <a name="postinstall"></a>
508 <a name="postinstall="></a>
510 <div class="method-heading attribute-method-heading">
511 <span class="method-name">postinstall</span><span
512 class="attribute-access-type">[RW]</span>
515 <div class="method-description">
517 <p class="missing-docs">(Not documented)</p>
522 <div id="mcname-attribute-method" class="method-detail">
523 <a name="mcname"></a>
525 <a name="mcname="></a>
527 <div class="method-heading attribute-method-heading">
528 <span class="method-name">mcname</span><span
529 class="attribute-access-type">[RW]</span>
532 <div class="method-description">
534 <p class="missing-docs">(Not documented)</p>
539 <div id="mcversion-attribute-method" class="method-detail">
540 <a name="mcversion"></a>
542 <a name="mcversion="></a>
544 <div class="method-heading attribute-method-heading">
545 <span class="method-name">mcversion</span><span
546 class="attribute-access-type">[RW]</span>
549 <div class="method-description">
551 <p class="missing-docs">(Not documented)</p>
561 <div id="public-class-method-details" class="method-section section">
562 <h3 class="section-header">Public Class Methods</h3>
565 <div id="new-method" class="method-detail ">
566 <a name="M000090"></a>
568 <div class="method-heading">
570 <span class="method-name">new</span><span
571 class="method-args">(configuration, mcdependency, plugintype)</span>
572 <span class="method-click-advice">click to toggle source</span>
576 <div class="method-description">
578 <p class="missing-docs">(Not documented)</p>
582 <div class="method-source-code"
585 <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/agent_definition.rb, line 8</span>
586 8: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">configuration</span>, <span class="ruby-identifier">mcdependency</span>, <span class="ruby-identifier">plugintype</span>)
587 9: <span class="ruby-ivar">@plugintype</span> = <span class="ruby-identifier">plugintype</span>
588 10: <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:target</span>]
589 11: <span class="ruby-ivar">@packagedata</span> = {}
590 12: <span class="ruby-ivar">@revision</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:revision</span>] <span class="ruby-operator">||</span> <span class="ruby-value">1</span>
591 13: <span class="ruby-ivar">@preinstall</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:preinstall</span>]
592 14: <span class="ruby-ivar">@postinstall</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:postinstall</span>]
593 15: <span class="ruby-ivar">@vendor</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:vendor</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">"Puppet Labs"</span>
594 16: <span class="ruby-ivar">@dependencies</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:dependency</span>] <span class="ruby-operator">||</span> []
595 17: <span class="ruby-ivar">@target_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-ivar">@path</span>)
596 18: <span class="ruby-ivar">@metadata</span>, <span class="ruby-identifier">mcversion</span> = <span class="ruby-constant">PluginPackager</span>.<span class="ruby-identifier">get_metadata</span>(<span class="ruby-ivar">@path</span>, <span class="ruby-value str">"agent"</span>)
597 19: <span class="ruby-ivar">@mcname</span> = <span class="ruby-identifier">mcdependency</span>[<span class="ruby-identifier">:mcname</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">"mcollective"</span>
598 20: <span class="ruby-ivar">@mcversion</span> = <span class="ruby-identifier">mcdependency</span>[<span class="ruby-identifier">:mcversion</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">mcversion</span>
599 21: <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>] = (<span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:version</span>] <span class="ruby-operator">||</span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>])
600 22: <span class="ruby-ivar">@dependencies</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{@mcname}-common"</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@mcversion</span>}
601 23: <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:name</span>] = (<span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:pluginname</span>] <span class="ruby-operator">||</span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:name</span>]).<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/\s+|_/</span>, <span class="ruby-value str">"-"</span>)
602 24: <span class="ruby-identifier">identify_packages</span>
603 25: <span class="ruby-keyword kw">end</span></pre>
614 <div id="public-instance-method-details" class="method-section section">
615 <h3 class="section-header">Public Instance Methods</h3>
618 <div id="agent-method" class="method-detail ">
619 <a name="M000097"></a>
621 <div class="method-heading">
623 <span class="method-name">agent</span><span
624 class="method-args">()</span>
625 <span class="method-click-advice">click to toggle source</span>
629 <div class="method-description">
632 Obtain <a href="../Agent.html">Agent</a> package files and dependencies.
637 <div class="method-source-code"
640 <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/agent_definition.rb, line 38</span>
641 38: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">agent</span>
642 39: <span class="ruby-identifier">agent</span> = {<span class="ruby-identifier">:files</span> =<span class="ruby-operator">></span> [],
643 40: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
644 41: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"Agent plugin for #{@metadata[:name]}"</span>}
646 43: <span class="ruby-identifier">agentdir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>, <span class="ruby-value str">"agent"</span>)
648 45: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">PluginPackager</span>.<span class="ruby-identifier">check_dir_present</span> <span class="ruby-identifier">agentdir</span>
649 46: <span class="ruby-identifier">ddls</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">agentdir</span>, <span class="ruby-value str">"*.ddl"</span>))
650 47: <span class="ruby-identifier">agent</span>[<span class="ruby-identifier">:files</span>] = (<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">agentdir</span>, <span class="ruby-value str">"*"</span>)) <span class="ruby-operator">-</span> <span class="ruby-identifier">ddls</span>)
651 48: <span class="ruby-keyword kw">else</span>
652 49: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
653 50: <span class="ruby-keyword kw">end</span>
654 51: <span class="ruby-identifier">agent</span>[<span class="ruby-identifier">:plugindependency</span>] = {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{@mcname}-#{@metadata[:name]}-common"</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>], <span class="ruby-identifier">:revision</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@revision</span>}
655 52: <span class="ruby-identifier">agent</span>
656 53: <span class="ruby-keyword kw">end</span></pre>
665 <div id="client-method" class="method-detail ">
666 <a name="M000099"></a>
668 <div class="method-heading">
670 <span class="method-name">client</span><span
671 class="method-args">()</span>
672 <span class="method-click-advice">click to toggle source</span>
676 <div class="method-description">
679 Obtain client package files and dependencies.
684 <div class="method-source-code"
687 <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/agent_definition.rb, line 56</span>
688 56: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">client</span>
689 57: <span class="ruby-identifier">client</span> = {<span class="ruby-identifier">:files</span> =<span class="ruby-operator">></span> [],
690 58: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
691 59: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"Client plugin for #{@metadata[:name]}"</span>}
693 61: <span class="ruby-identifier">clientdir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>, <span class="ruby-value str">"application"</span>)
694 62: <span class="ruby-identifier">aggregatedir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>, <span class="ruby-value str">"aggregate"</span>)
696 64: <span class="ruby-identifier">client</span>[<span class="ruby-identifier">:files</span>] <span class="ruby-operator">+=</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">clientdir</span>, <span class="ruby-value str">"*"</span>)) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">PluginPackager</span>.<span class="ruby-identifier">check_dir_present</span> <span class="ruby-identifier">clientdir</span>
697 65: <span class="ruby-identifier">client</span>[<span class="ruby-identifier">:files</span>] <span class="ruby-operator">+=</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">aggregatedir</span>, <span class="ruby-value str">"*"</span>)) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">PluginPackager</span>.<span class="ruby-identifier">check_dir_present</span> <span class="ruby-identifier">aggregatedir</span>
698 66: <span class="ruby-identifier">client</span>[<span class="ruby-identifier">:plugindependency</span>] = {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{@mcname}-#{@metadata[:name]}-common"</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>], <span class="ruby-identifier">:revision</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@revision</span>}
699 67: <span class="ruby-identifier">client</span>[<span class="ruby-identifier">:files</span>].<span class="ruby-identifier">empty?</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">client</span>
700 68: <span class="ruby-keyword kw">end</span></pre>
709 <div id="common-method" class="method-detail ">
710 <a name="M000100"></a>
712 <div class="method-heading">
714 <span class="method-name">common</span><span
715 class="method-args">()</span>
716 <span class="method-click-advice">click to toggle source</span>
720 <div class="method-description">
723 Obtain common package files and dependencies.
728 <div class="method-source-code"
731 <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/agent_definition.rb, line 71</span>
732 71: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">common</span>
733 72: <span class="ruby-identifier">common</span> = {<span class="ruby-identifier">:files</span> =<span class="ruby-operator">></span>[],
734 73: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
735 74: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"Common libraries for #{@metadata[:name]}"</span>}
737 76: <span class="ruby-identifier">datadir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>, <span class="ruby-value str">"data"</span>, <span class="ruby-value str">"**"</span>)
738 77: <span class="ruby-identifier">utildir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>, <span class="ruby-value str">"util"</span>, <span class="ruby-value str">"**"</span>, <span class="ruby-value str">"**"</span>)
739 78: <span class="ruby-identifier">ddldir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>, <span class="ruby-value str">"agent"</span>, <span class="ruby-value str">"*.ddl"</span>)
740 79: <span class="ruby-identifier">validatordir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>, <span class="ruby-value str">"validator"</span>, <span class="ruby-value str">"**"</span>)
742 81: [<span class="ruby-identifier">datadir</span>, <span class="ruby-identifier">utildir</span>, <span class="ruby-identifier">validatordir</span>, <span class="ruby-identifier">ddldir</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">directory</span><span class="ruby-operator">|</span>
743 82: <span class="ruby-identifier">common</span>[<span class="ruby-identifier">:files</span>] <span class="ruby-operator">+=</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-identifier">directory</span>)
744 83: <span class="ruby-keyword kw">end</span>
746 85: <span class="ruby-comment cmt"># We fail if there is no ddl file present</span>
747 86: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">common</span>[<span class="ruby-identifier">:files</span>].<span class="ruby-identifier">grep</span>(<span class="ruby-regexp re">/^.*\.ddl$/</span>).<span class="ruby-identifier">empty?</span>
748 87: <span class="ruby-identifier">raise</span> <span class="ruby-node">"cannot create package - No ddl file found in #{File.join(@path, "agent")}"</span>
749 88: <span class="ruby-keyword kw">end</span>
751 90: <span class="ruby-identifier">common</span>[<span class="ruby-identifier">:files</span>].<span class="ruby-identifier">empty?</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">common</span>
752 91: <span class="ruby-keyword kw">end</span></pre>
761 <div id="identify-packages-method" class="method-detail ">
762 <a name="M000094"></a>
764 <div class="method-heading">
766 <span class="method-name">identify_packages</span><span
767 class="method-args">()</span>
768 <span class="method-click-advice">click to toggle source</span>
772 <div class="method-description">
775 Identify present packages and populate packagedata hash.
780 <div class="method-source-code"
781 id="identify-packages-source">
783 <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/agent_definition.rb, line 28</span>
784 28: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">identify_packages</span>
785 29: <span class="ruby-identifier">common_package</span> = <span class="ruby-identifier">common</span>
786 30: <span class="ruby-ivar">@packagedata</span>[<span class="ruby-identifier">:common</span>] = <span class="ruby-identifier">common_package</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">common_package</span>
787 31: <span class="ruby-identifier">agent_package</span> = <span class="ruby-identifier">agent</span>
788 32: <span class="ruby-ivar">@packagedata</span>[<span class="ruby-identifier">:agent</span>] = <span class="ruby-identifier">agent_package</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">agent_package</span>
789 33: <span class="ruby-identifier">client_package</span> = <span class="ruby-identifier">client</span>
790 34: <span class="ruby-ivar">@packagedata</span>[<span class="ruby-identifier">:client</span>] = <span class="ruby-identifier">client_package</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">client_package</span>
791 35: <span class="ruby-keyword kw">end</span></pre>
806 <div id="rdoc-debugging-section-dump" class="debugging-section">
808 <p>Disabled; run with --debug to generate this.</p>
812 <div id="validator-badges">
813 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
814 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
815 Rdoc Generator</a> 1.1.6</small>.</p>