Update version according to OSCI-883
[packages/precise/mcollective.git] / doc / MCollective / PluginPackager / AgentDefinition.html
diff --git a/doc/MCollective/PluginPackager/AgentDefinition.html b/doc/MCollective/PluginPackager/AgentDefinition.html
new file mode 100644 (file)
index 0000000..c95beea
--- /dev/null
@@ -0,0 +1,820 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+       <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+       <title>Class: MCollective::PluginPackager::AgentDefinition</title>
+
+       <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
+
+       <script src="../../js/jquery.js" type="text/javascript"
+               charset="utf-8"></script>
+       <script src="../../js/thickbox-compressed.js" type="text/javascript"
+               charset="utf-8"></script>
+       <script src="../../js/quicksearch.js" type="text/javascript"
+               charset="utf-8"></script>
+       <script src="../../js/darkfish.js" type="text/javascript"
+               charset="utf-8"></script>
+
+</head>
+<body class="class">
+
+       <div id="metadata">
+               <div id="file-metadata">
+                       <div id="file-list-section" class="section">
+                               <h3 class="section-header">In Files</h3>
+                               <div class="section-body">
+                                       <ul>
+                                       
+                                               <li><a href="../../lib/mcollective/pluginpackager/agent_definition_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+                                                       class="thickbox" title="lib/mcollective/pluginpackager/agent_definition.rb">lib/mcollective/pluginpackager/agent_definition.rb</a></li>
+                                       
+                                       </ul>
+                               </div>
+                       </div>
+
+                       
+               </div>
+
+               <div id="class-metadata">
+
+                       <!-- Parent Class -->
+                       
+                       <div id="parent-class-section" class="section">
+                               <h3 class="section-header">Parent</h3>
+                               
+                               <p class="link"><a href="../../Object.html">Object</a></p>
+                               
+                       </div>
+                       
+
+                       <!-- Namespace Contents -->
+                       
+
+                       <!-- Method Quickref -->
+                       
+                       <div id="method-list-section" class="section">
+                               <h3 class="section-header">Methods</h3>
+                               <ul class="link-list">
+                                       
+                                       <li><a href="#M000090">::new</a></li>
+                                       
+                                       <li><a href="#M000092">#agent</a></li>
+                                       
+                                       <li><a href="#M000093">#client</a></li>
+                                       
+                                       <li><a href="#M000094">#common</a></li>
+                                       
+                                       <li><a href="#M000091">#identify_packages</a></li>
+                                       
+                               </ul>
+                       </div>
+                       
+
+                       <!-- Included Modules -->
+                       
+               </div>
+
+               <div id="project-metadata">
+                       
+                       
+                       <div id="fileindex-section" class="section project-section">
+                               <h3 class="section-header">Files</h3>
+                               <ul>
+                               
+                                       <li class="file"><a href="../../COPYING.html">COPYING</a></li>
+                               
+                                       <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
+                               
+                                       <li class="file"><a href="../../README.html">README</a></li>
+                               
+                                       <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
+                               
+                                       <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
+                               
+                                       <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
+                               
+                                       <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
+                               
+                                       <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
+                               
+                                       <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
+                               
+                                       <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
+                               
+                                       <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
+                               
+                                       <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
+                               
+                                       <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
+                               
+                                       <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
+                               
+                                       <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
+                               
+                               </ul>
+                       </div>
+                       
+
+                       <div id="classindex-section" class="section project-section">
+                               <h3 class="section-header">Class Index
+                                       <span class="search-toggle"><img src="../../images/find.png"
+                                               height="16" width="16" alt="[+]"
+                                               title="show/hide quicksearch" /></span></h3>
+                               <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+                               <fieldset>
+                                       <legend>Quicksearch</legend>
+                                       <input type="text" name="quicksearch" value=""
+                                               class="quicksearch-field" />
+                               </fieldset>
+                               </form>
+
+                               <ul class="link-list">
+                               
+                                       <li><a href="../../MCollective.html">MCollective</a></li>
+                               
+                                       <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
+                               
+                                       <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
+                               
+                                       <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
+                               
+                                       <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
+                               
+                                       <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
+                               
+                                       <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
+                               
+                                       <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
+                               
+                                       <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
+                               
+                                       <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
+                               
+                                       <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
+                               
+                                       <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
+                               
+                                       <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
+                               
+                                       <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
+                               
+                                       <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
+                               
+                                       <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
+                               
+                                       <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
+                               
+                                       <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
+                               
+                                       <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
+                               
+                                       <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
+                               
+                                       <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
+                               
+                                       <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
+                               
+                                       <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
+                               
+                                       <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
+                               
+                                       <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
+                               
+                                       <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
+                               
+                                       <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
+                               
+                                       <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
+                               
+                                       <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
+                               
+                                       <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
+                               
+                                       <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
+                               
+                                       <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
+                               
+                                       <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
+                               
+                                       <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
+                               
+                                       <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
+                               
+                                       <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
+                               
+                                       <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
+                               
+                                       <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
+                               
+                                       <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
+                               
+                                       <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
+                               
+                                       <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
+                               
+                                       <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
+                               
+                                       <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
+                               
+                                       <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
+                               
+                                       <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
+                               
+                                       <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
+                               
+                                       <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
+                               
+                                       <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
+                               
+                                       <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
+                               
+                                       <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
+                               
+                                       <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
+                               
+                                       <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
+                               
+                                       <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
+                               
+                                       <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
+                               
+                                       <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
+                               
+                                       <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
+                               
+                                       <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
+                               
+                                       <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
+                               
+                                       <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
+                               
+                                       <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
+                               
+                                       <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
+                               
+                                       <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
+                               
+                                       <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
+                               
+                                       <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
+                               
+                                       <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
+                               
+                                       <li><a href="../../Array.html">Array</a></li>
+                               
+                                       <li><a href="../../Dir.html">Dir</a></li>
+                               
+                                       <li><a href="../../Object.html">Object</a></li>
+                               
+                                       <li><a href="../../String.html">String</a></li>
+                               
+                                       <li><a href="../../Symbol.html">Symbol</a></li>
+                               
+                               </ul>
+                               <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+                       </div>
+
+                       
+               </div>
+       </div>
+
+       <div id="documentation">
+               <h1 class="class">MCollective::PluginPackager::AgentDefinition</h1>
+
+               <div id="description">
+                       <p>
+<a href="../../MCollective.html">MCollective</a> <a
+href="../Agent.html">Agent</a> Plugin package
+</p>
+
+               </div>
+
+               <!-- Constants -->
+               
+
+               <!-- Attributes -->
+               
+               <div id="attribute-method-details" class="method-section section">
+                       <h3 class="section-header">Attributes</h3>
+
+                       
+                       <div id="path-attribute-method" class="method-detail">
+                               <a name="path"></a>
+                               
+                               <a name="path="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">path</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="packagedata-attribute-method" class="method-detail">
+                               <a name="packagedata"></a>
+                               
+                               <a name="packagedata="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">packagedata</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="metadata-attribute-method" class="method-detail">
+                               <a name="metadata"></a>
+                               
+                               <a name="metadata="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">metadata</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="target-path-attribute-method" class="method-detail">
+                               <a name="target_path"></a>
+                               
+                               <a name="target_path="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">target_path</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="vendor-attribute-method" class="method-detail">
+                               <a name="vendor"></a>
+                               
+                               <a name="vendor="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">vendor</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="revision-attribute-method" class="method-detail">
+                               <a name="revision"></a>
+                               
+                               <a name="revision="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">revision</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="preinstall-attribute-method" class="method-detail">
+                               <a name="preinstall"></a>
+                               
+                               <a name="preinstall="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">preinstall</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="plugintype-attribute-method" class="method-detail">
+                               <a name="plugintype"></a>
+                               
+                               <a name="plugintype="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">plugintype</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="dependencies-attribute-method" class="method-detail">
+                               <a name="dependencies"></a>
+                               
+                               <a name="dependencies="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">dependencies</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="postinstall-attribute-method" class="method-detail">
+                               <a name="postinstall"></a>
+                               
+                               <a name="postinstall="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">postinstall</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="mcname-attribute-method" class="method-detail">
+                               <a name="mcname"></a>
+                               
+                               <a name="mcname="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">mcname</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="mcversion-attribute-method" class="method-detail">
+                               <a name="mcversion"></a>
+                               
+                               <a name="mcversion="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">mcversion</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+               </div>
+               
+
+               <!-- Methods -->
+               
+               <div id="public-class-method-details" class="method-section section">
+                       <h3 class="section-header">Public Class Methods</h3>
+
+               
+                       <div id="new-method" class="method-detail ">
+                               <a name="M000090"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">new</span><span
+                                               class="method-args">(configuration, mcdependency, plugintype)</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p class="missing-docs">(Not documented)</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="new-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/agent_definition.rb, line 8</span>
+ 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>)
+ 9:         <span class="ruby-ivar">@plugintype</span> = <span class="ruby-identifier">plugintype</span>
+10:         <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:target</span>]
+11:         <span class="ruby-ivar">@packagedata</span> = {}
+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>
+13:         <span class="ruby-ivar">@preinstall</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:preinstall</span>]
+14:         <span class="ruby-ivar">@postinstall</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:postinstall</span>]
+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">&quot;Puppet Labs&quot;</span>
+16:         <span class="ruby-ivar">@dependencies</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:dependency</span>] <span class="ruby-operator">||</span> []
+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>)
+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">&quot;agent&quot;</span>)
+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">&quot;mcollective&quot;</span>
+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>
+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>])
+22:         <span class="ruby-ivar">@dependencies</span> <span class="ruby-operator">&lt;&lt;</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;#{@mcname}-common&quot;</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@mcversion</span>}
+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">&quot;-&quot;</span>)
+24:         <span class="ruby-identifier">identify_packages</span>
+25:       <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+               </div>
+       
+               <div id="public-instance-method-details" class="method-section section">
+                       <h3 class="section-header">Public Instance Methods</h3>
+
+               
+                       <div id="agent-method" class="method-detail ">
+                               <a name="M000092"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">agent</span><span
+                                               class="method-args">()</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p>
+Obtain <a href="../Agent.html">Agent</a> package files and dependencies.
+</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="agent-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/agent_definition.rb, line 38</span>
+38:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">agent</span>
+39:         <span class="ruby-identifier">agent</span> = {<span class="ruby-identifier">:files</span> =<span class="ruby-operator">&gt;</span> [],
+40:                  <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
+41:                  <span class="ruby-identifier">:description</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;Agent plugin for #{@metadata[:name]}&quot;</span>}
+42: 
+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">&quot;agent&quot;</span>)
+44: 
+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>
+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">&quot;*.ddl&quot;</span>))
+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">&quot;*&quot;</span>)) <span class="ruby-operator">-</span> <span class="ruby-identifier">ddls</span>)
+48:         <span class="ruby-keyword kw">else</span>
+49:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
+50:         <span class="ruby-keyword kw">end</span>
+51:         <span class="ruby-identifier">agent</span>[<span class="ruby-identifier">:plugindependency</span>] = {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;#{@mcname}-#{@metadata[:name]}-common&quot;</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>], <span class="ruby-identifier">:revision</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@revision</span>}
+52:         <span class="ruby-identifier">agent</span>
+53:       <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+                       <div id="client-method" class="method-detail ">
+                               <a name="M000093"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">client</span><span
+                                               class="method-args">()</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p>
+Obtain client package files and dependencies.
+</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="client-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/agent_definition.rb, line 56</span>
+56:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">client</span>
+57:         <span class="ruby-identifier">client</span> = {<span class="ruby-identifier">:files</span> =<span class="ruby-operator">&gt;</span> [],
+58:                   <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
+59:                   <span class="ruby-identifier">:description</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;Client plugin for #{@metadata[:name]}&quot;</span>}
+60: 
+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">&quot;application&quot;</span>)
+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">&quot;aggregate&quot;</span>)
+63: 
+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">&quot;*&quot;</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>
+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">&quot;*&quot;</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>
+66:         <span class="ruby-identifier">client</span>[<span class="ruby-identifier">:plugindependency</span>] = {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;#{@mcname}-#{@metadata[:name]}-common&quot;</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>], <span class="ruby-identifier">:revision</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@revision</span>}
+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>
+68:       <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+                       <div id="common-method" class="method-detail ">
+                               <a name="M000094"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">common</span><span
+                                               class="method-args">()</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p>
+Obtain common package files and dependencies.
+</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="common-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/agent_definition.rb, line 71</span>
+71:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">common</span>
+72:         <span class="ruby-identifier">common</span> = {<span class="ruby-identifier">:files</span> =<span class="ruby-operator">&gt;</span>[],
+73:                   <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
+74:                   <span class="ruby-identifier">:description</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;Common libraries for #{@metadata[:name]}&quot;</span>}
+75: 
+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">&quot;data&quot;</span>, <span class="ruby-value str">&quot;**&quot;</span>)
+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">&quot;util&quot;</span>, <span class="ruby-value str">&quot;**&quot;</span>, <span class="ruby-value str">&quot;**&quot;</span>)
+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">&quot;agent&quot;</span>, <span class="ruby-value str">&quot;*.ddl&quot;</span>)
+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">&quot;validator&quot;</span>, <span class="ruby-value str">&quot;**&quot;</span>)
+80: 
+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>
+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>)
+83:         <span class="ruby-keyword kw">end</span>
+84: 
+85:         <span class="ruby-comment cmt"># We fail if there is no ddl file present</span>
+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>
+87:           <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;cannot create package - No ddl file found in #{File.join(@path, &quot;agent&quot;)}&quot;</span>
+88:         <span class="ruby-keyword kw">end</span>
+89: 
+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>
+91:       <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+                       <div id="identify-packages-method" class="method-detail ">
+                               <a name="M000091"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">identify_packages</span><span
+                                               class="method-args">()</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p>
+Identify present packages and populate packagedata hash.
+</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="identify-packages-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/agent_definition.rb, line 28</span>
+28:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">identify_packages</span>
+29:         <span class="ruby-identifier">common_package</span> = <span class="ruby-identifier">common</span>
+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>
+31:         <span class="ruby-identifier">agent_package</span> = <span class="ruby-identifier">agent</span>
+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>
+33:         <span class="ruby-identifier">client_package</span> = <span class="ruby-identifier">client</span>
+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>
+35:       <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+               </div>
+       
+
+       </div>
+
+
+       <div id="rdoc-debugging-section-dump" class="debugging-section">
+       
+               <p>Disabled; run with --debug to generate this.</p>
+       
+       </div>
+
+       <div id="validator-badges">
+               <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+               <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+                       Rdoc Generator</a> 1.1.6</small>.</p>
+       </div>
+
+</body>
+</html>
+