Update version according to OSCI-883
[packages/precise/mcollective.git] / doc / MCollective / PluginPackager / StandardDefinition.html
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">
5 <head>
6         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
8         <title>Class: MCollective::PluginPackager::StandardDefinition</title>
9
10         <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
11
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>
20
21 </head>
22 <body class="class">
23
24         <div id="metadata">
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">
29                                         <ul>
30                                         
31                                                 <li><a href="../../lib/mcollective/pluginpackager/standard_definition_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32                                                         class="thickbox" title="lib/mcollective/pluginpackager/standard_definition.rb">lib/mcollective/pluginpackager/standard_definition.rb</a></li>
33                                         
34                                         </ul>
35                                 </div>
36                         </div>
37
38                         
39                 </div>
40
41                 <div id="class-metadata">
42
43                         <!-- Parent Class -->
44                         
45                         <div id="parent-class-section" class="section">
46                                 <h3 class="section-header">Parent</h3>
47                                 
48                                 <p class="link"><a href="../../Object.html">Object</a></p>
49                                 
50                         </div>
51                         
52
53                         <!-- Namespace Contents -->
54                         
55
56                         <!-- Method Quickref -->
57                         
58                         <div id="method-list-section" class="section">
59                                 <h3 class="section-header">Methods</h3>
60                                 <ul class="link-list">
61                                         
62                                         <li><a href="#M000086">::new</a></li>
63                                         
64                                         <li><a href="#M000089">#common</a></li>
65                                         
66                                         <li><a href="#M000087">#identify_packages</a></li>
67                                         
68                                         <li><a href="#M000088">#plugin</a></li>
69                                         
70                                 </ul>
71                         </div>
72                         
73
74                         <!-- Included Modules -->
75                         
76                 </div>
77
78                 <div id="project-metadata">
79                         
80                         
81                         <div id="fileindex-section" class="section project-section">
82                                 <h3 class="section-header">Files</h3>
83                                 <ul>
84                                 
85                                         <li class="file"><a href="../../COPYING.html">COPYING</a></li>
86                                 
87                                         <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
88                                 
89                                         <li class="file"><a href="../../README.html">README</a></li>
90                                 
91                                         <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
92                                 
93                                         <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
94                                 
95                                         <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
96                                 
97                                         <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
98                                 
99                                         <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
100                                 
101                                         <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
102                                 
103                                         <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
104                                 
105                                         <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
106                                 
107                                         <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
108                                 
109                                         <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
110                                 
111                                         <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
112                                 
113                                         <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
114                                 
115                                         <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
116                                 
117                                         <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
118                                 
119                                         <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
120                                 
121                                         <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
122                                 
123                                         <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
124                                 
125                                 </ul>
126                         </div>
127                         
128
129                         <div id="classindex-section" class="section project-section">
130                                 <h3 class="section-header">Class Index
131                                         <span class="search-toggle"><img src="../../images/find.png"
132                                                 height="16" width="16" alt="[+]"
133                                                 title="show/hide quicksearch" /></span></h3>
134                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
135                                 <fieldset>
136                                         <legend>Quicksearch</legend>
137                                         <input type="text" name="quicksearch" value=""
138                                                 class="quicksearch-field" />
139                                 </fieldset>
140                                 </form>
141
142                                 <ul class="link-list">
143                                 
144                                         <li><a href="../../MCollective.html">MCollective</a></li>
145                                 
146                                         <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
147                                 
148                                         <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
149                                 
150                                         <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
151                                 
152                                         <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
153                                 
154                                         <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
155                                 
156                                         <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
157                                 
158                                         <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
159                                 
160                                         <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
161                                 
162                                         <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
163                                 
164                                         <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
165                                 
166                                         <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
167                                 
168                                         <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
169                                 
170                                         <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
171                                 
172                                         <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
173                                 
174                                         <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
175                                 
176                                         <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
177                                 
178                                         <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
179                                 
180                                         <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
181                                 
182                                         <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
183                                 
184                                         <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
185                                 
186                                         <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
187                                 
188                                         <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
189                                 
190                                         <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
191                                 
192                                         <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
193                                 
194                                         <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
195                                 
196                                         <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
197                                 
198                                         <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
199                                 
200                                         <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
201                                 
202                                         <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
203                                 
204                                         <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
205                                 
206                                         <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
207                                 
208                                         <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
209                                 
210                                         <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
211                                 
212                                         <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
213                                 
214                                         <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
215                                 
216                                         <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
217                                 
218                                         <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
219                                 
220                                         <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
221                                 
222                                         <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
223                                 
224                                         <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
225                                 
226                                         <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
227                                 
228                                         <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
229                                 
230                                         <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
231                                 
232                                         <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
233                                 
234                                         <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
235                                 
236                                         <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
237                                 
238                                         <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
239                                 
240                                         <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
241                                 
242                                         <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
243                                 
244                                         <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
245                                 
246                                         <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
247                                 
248                                         <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
249                                 
250                                         <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
251                                 
252                                         <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
253                                 
254                                         <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
255                                 
256                                         <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
257                                 
258                                         <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
259                                 
260                                         <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
261                                 
262                                         <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
263                                 
264                                         <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
265                                 
266                                         <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
267                                 
268                                         <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
269                                 
270                                         <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
271                                 
272                                         <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
273                                 
274                                         <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
275                                 
276                                         <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
277                                 
278                                         <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
279                                 
280                                         <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
281                                 
282                                         <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
283                                 
284                                         <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
285                                 
286                                         <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
287                                 
288                                         <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
289                                 
290                                         <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
291                                 
292                                         <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
293                                 
294                                         <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
295                                 
296                                         <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
297                                 
298                                         <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
299                                 
300                                         <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
301                                 
302                                         <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
303                                 
304                                         <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
305                                 
306                                         <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
307                                 
308                                         <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
309                                 
310                                         <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
311                                 
312                                         <li><a href="../../Array.html">Array</a></li>
313                                 
314                                         <li><a href="../../Dir.html">Dir</a></li>
315                                 
316                                         <li><a href="../../Object.html">Object</a></li>
317                                 
318                                         <li><a href="../../String.html">String</a></li>
319                                 
320                                         <li><a href="../../Symbol.html">Symbol</a></li>
321                                 
322                                 </ul>
323                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
324                         </div>
325
326                         
327                 </div>
328         </div>
329
330         <div id="documentation">
331                 <h1 class="class">MCollective::PluginPackager::StandardDefinition</h1>
332
333                 <div id="description">
334                         
335                 </div>
336
337                 <!-- Constants -->
338                 
339
340                 <!-- Attributes -->
341                 
342                 <div id="attribute-method-details" class="method-section section">
343                         <h3 class="section-header">Attributes</h3>
344
345                         
346                         <div id="path-attribute-method" class="method-detail">
347                                 <a name="path"></a>
348                                 
349                                 <a name="path="></a>
350                                 
351                                 <div class="method-heading attribute-method-heading">
352                                         <span class="method-name">path</span><span
353                                                 class="attribute-access-type">[RW]</span>
354                                 </div>
355
356                                 <div class="method-description">
357                                 
358                                 <p class="missing-docs">(Not documented)</p>
359                                 
360                                 </div>
361                         </div>
362                         
363                         <div id="packagedata-attribute-method" class="method-detail">
364                                 <a name="packagedata"></a>
365                                 
366                                 <a name="packagedata="></a>
367                                 
368                                 <div class="method-heading attribute-method-heading">
369                                         <span class="method-name">packagedata</span><span
370                                                 class="attribute-access-type">[RW]</span>
371                                 </div>
372
373                                 <div class="method-description">
374                                 
375                                 <p class="missing-docs">(Not documented)</p>
376                                 
377                                 </div>
378                         </div>
379                         
380                         <div id="metadata-attribute-method" class="method-detail">
381                                 <a name="metadata"></a>
382                                 
383                                 <a name="metadata="></a>
384                                 
385                                 <div class="method-heading attribute-method-heading">
386                                         <span class="method-name">metadata</span><span
387                                                 class="attribute-access-type">[RW]</span>
388                                 </div>
389
390                                 <div class="method-description">
391                                 
392                                 <p class="missing-docs">(Not documented)</p>
393                                 
394                                 </div>
395                         </div>
396                         
397                         <div id="target-path-attribute-method" class="method-detail">
398                                 <a name="target_path"></a>
399                                 
400                                 <a name="target_path="></a>
401                                 
402                                 <div class="method-heading attribute-method-heading">
403                                         <span class="method-name">target_path</span><span
404                                                 class="attribute-access-type">[RW]</span>
405                                 </div>
406
407                                 <div class="method-description">
408                                 
409                                 <p class="missing-docs">(Not documented)</p>
410                                 
411                                 </div>
412                         </div>
413                         
414                         <div id="vendor-attribute-method" class="method-detail">
415                                 <a name="vendor"></a>
416                                 
417                                 <a name="vendor="></a>
418                                 
419                                 <div class="method-heading attribute-method-heading">
420                                         <span class="method-name">vendor</span><span
421                                                 class="attribute-access-type">[RW]</span>
422                                 </div>
423
424                                 <div class="method-description">
425                                 
426                                 <p class="missing-docs">(Not documented)</p>
427                                 
428                                 </div>
429                         </div>
430                         
431                         <div id="revision-attribute-method" class="method-detail">
432                                 <a name="revision"></a>
433                                 
434                                 <a name="revision="></a>
435                                 
436                                 <div class="method-heading attribute-method-heading">
437                                         <span class="method-name">revision</span><span
438                                                 class="attribute-access-type">[RW]</span>
439                                 </div>
440
441                                 <div class="method-description">
442                                 
443                                 <p class="missing-docs">(Not documented)</p>
444                                 
445                                 </div>
446                         </div>
447                         
448                         <div id="plugintype-attribute-method" class="method-detail">
449                                 <a name="plugintype"></a>
450                                 
451                                 <a name="plugintype="></a>
452                                 
453                                 <div class="method-heading attribute-method-heading">
454                                         <span class="method-name">plugintype</span><span
455                                                 class="attribute-access-type">[RW]</span>
456                                 </div>
457
458                                 <div class="method-description">
459                                 
460                                 <p class="missing-docs">(Not documented)</p>
461                                 
462                                 </div>
463                         </div>
464                         
465                         <div id="preinstall-attribute-method" class="method-detail">
466                                 <a name="preinstall"></a>
467                                 
468                                 <a name="preinstall="></a>
469                                 
470                                 <div class="method-heading attribute-method-heading">
471                                         <span class="method-name">preinstall</span><span
472                                                 class="attribute-access-type">[RW]</span>
473                                 </div>
474
475                                 <div class="method-description">
476                                 
477                                 <p class="missing-docs">(Not documented)</p>
478                                 
479                                 </div>
480                         </div>
481                         
482                         <div id="postinstall-attribute-method" class="method-detail">
483                                 <a name="postinstall"></a>
484                                 
485                                 <a name="postinstall="></a>
486                                 
487                                 <div class="method-heading attribute-method-heading">
488                                         <span class="method-name">postinstall</span><span
489                                                 class="attribute-access-type">[RW]</span>
490                                 </div>
491
492                                 <div class="method-description">
493                                 
494                                 <p class="missing-docs">(Not documented)</p>
495                                 
496                                 </div>
497                         </div>
498                         
499                         <div id="dependencies-attribute-method" class="method-detail">
500                                 <a name="dependencies"></a>
501                                 
502                                 <a name="dependencies="></a>
503                                 
504                                 <div class="method-heading attribute-method-heading">
505                                         <span class="method-name">dependencies</span><span
506                                                 class="attribute-access-type">[RW]</span>
507                                 </div>
508
509                                 <div class="method-description">
510                                 
511                                 <p class="missing-docs">(Not documented)</p>
512                                 
513                                 </div>
514                         </div>
515                         
516                         <div id="mcname-attribute-method" class="method-detail">
517                                 <a name="mcname"></a>
518                                 
519                                 <a name="mcname="></a>
520                                 
521                                 <div class="method-heading attribute-method-heading">
522                                         <span class="method-name">mcname</span><span
523                                                 class="attribute-access-type">[RW]</span>
524                                 </div>
525
526                                 <div class="method-description">
527                                 
528                                 <p class="missing-docs">(Not documented)</p>
529                                 
530                                 </div>
531                         </div>
532                         
533                         <div id="mcversion-attribute-method" class="method-detail">
534                                 <a name="mcversion"></a>
535                                 
536                                 <a name="mcversion="></a>
537                                 
538                                 <div class="method-heading attribute-method-heading">
539                                         <span class="method-name">mcversion</span><span
540                                                 class="attribute-access-type">[RW]</span>
541                                 </div>
542
543                                 <div class="method-description">
544                                 
545                                 <p class="missing-docs">(Not documented)</p>
546                                 
547                                 </div>
548                         </div>
549                         
550                 </div>
551                 
552
553                 <!-- Methods -->
554                 
555                 <div id="public-class-method-details" class="method-section section">
556                         <h3 class="section-header">Public Class Methods</h3>
557
558                 
559                         <div id="new-method" class="method-detail ">
560                                 <a name="M000086"></a>
561
562                                 <div class="method-heading">
563                                 
564                                         <span class="method-name">new</span><span
565                                                 class="method-args">(configuration, mcdependency, plugintype)</span>
566                                         <span class="method-click-advice">click to toggle source</span>
567                                 
568                                 </div>
569
570                                 <div class="method-description">
571                                         
572                                         <p class="missing-docs">(Not documented)</p>
573                                         
574
575                                         
576                                         <div class="method-source-code"
577                                                 id="new-source">
578 <pre>
579     <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/standard_definition.rb, line 7</span>
580  7:       <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>)
581  8:         <span class="ruby-ivar">@plugintype</span> = <span class="ruby-identifier">plugintype</span>
582  9:         <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:target</span>]
583 10:         <span class="ruby-ivar">@packagedata</span> = {}
584 11:         <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>
585 12:         <span class="ruby-ivar">@preinstall</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:preinstall</span>]
586 13:         <span class="ruby-ivar">@postinstall</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:postinstall</span>]
587 14:         <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>
588 15:         <span class="ruby-ivar">@dependencies</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:dependency</span>] <span class="ruby-operator">||</span> []
589 16:         <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>)
590 17:         <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-ivar">@plugintype</span>)
591 18:         <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>
592 19:         <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>
593 20:         <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>}
594 21:         <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>)
595 22:         <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>])
596 23:         <span class="ruby-identifier">identify_packages</span>
597 24:       <span class="ruby-keyword kw">end</span></pre>
598                                         </div>
599                                         
600                                 </div>
601
602                                 
603                         </div>
604
605                 
606                 </div>
607         
608                 <div id="public-instance-method-details" class="method-section section">
609                         <h3 class="section-header">Public Instance Methods</h3>
610
611                 
612                         <div id="common-method" class="method-detail ">
613                                 <a name="M000089"></a>
614
615                                 <div class="method-heading">
616                                 
617                                         <span class="method-name">common</span><span
618                                                 class="method-args">()</span>
619                                         <span class="method-click-advice">click to toggle source</span>
620                                 
621                                 </div>
622
623                                 <div class="method-description">
624                                         
625                                         <p>
626 Obtain list of common files
627 </p>
628                                         
629
630                                         
631                                         <div class="method-source-code"
632                                                 id="common-source">
633 <pre>
634     <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/standard_definition.rb, line 54</span>
635 54:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">common</span>
636 55:         <span class="ruby-identifier">common</span> = {<span class="ruby-identifier">:files</span> =<span class="ruby-operator">&gt;</span> [],
637 56:                   <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
638 57:                   <span class="ruby-identifier">:description</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;Common libraries for #{@name} connector plugin&quot;</span>}
639 58: 
640 59:         <span class="ruby-identifier">commondir</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>)
641 60:         <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">commondir</span>
642 61:           <span class="ruby-identifier">common</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">commondir</span>, <span class="ruby-value str">&quot;*&quot;</span>))
643 62:           <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">common</span>
644 63:         <span class="ruby-keyword kw">else</span>
645 64:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
646 65:         <span class="ruby-keyword kw">end</span>
647 66:       <span class="ruby-keyword kw">end</span></pre>
648                                         </div>
649                                         
650                                 </div>
651
652                                 
653                         </div>
654
655                 
656                         <div id="identify-packages-method" class="method-detail ">
657                                 <a name="M000087"></a>
658
659                                 <div class="method-heading">
660                                 
661                                         <span class="method-name">identify_packages</span><span
662                                                 class="method-args">()</span>
663                                         <span class="method-click-advice">click to toggle source</span>
664                                 
665                                 </div>
666
667                                 <div class="method-description">
668                                         
669                                         <p>
670 Identify present packages and populate the packagedata hash
671 </p>
672                                         
673
674                                         
675                                         <div class="method-source-code"
676                                                 id="identify-packages-source">
677 <pre>
678     <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/standard_definition.rb, line 27</span>
679 27:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">identify_packages</span>
680 28:         <span class="ruby-identifier">common_package</span> = <span class="ruby-identifier">common</span>
681 29:         <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>
682 30:         <span class="ruby-identifier">plugin_package</span> = <span class="ruby-identifier">plugin</span>
683 31:         <span class="ruby-ivar">@packagedata</span>[<span class="ruby-ivar">@plugintype</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">plugin_package</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">plugin_package</span>
684 32:       <span class="ruby-keyword kw">end</span></pre>
685                                         </div>
686                                         
687                                 </div>
688
689                                 
690                         </div>
691
692                 
693                         <div id="plugin-method" class="method-detail ">
694                                 <a name="M000088"></a>
695
696                                 <div class="method-heading">
697                                 
698                                         <span class="method-name">plugin</span><span
699                                                 class="method-args">()</span>
700                                         <span class="method-click-advice">click to toggle source</span>
701                                 
702                                 </div>
703
704                                 <div class="method-description">
705                                         
706                                         <p>
707 Obtain standard plugin files and dependencies
708 </p>
709                                         
710
711                                         
712                                         <div class="method-source-code"
713                                                 id="plugin-source">
714 <pre>
715     <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/standard_definition.rb, line 35</span>
716 35:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">plugin</span>
717 36:         <span class="ruby-identifier">plugindata</span> = {<span class="ruby-identifier">:files</span> =<span class="ruby-operator">&gt;</span> [],
718 37:                       <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
719 38:                       <span class="ruby-identifier">:description</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;#{@name} #{@plugintype} plugin for the Marionette Collective.&quot;</span>}
720 39: 
721 40:         <span class="ruby-identifier">plugindir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>, <span class="ruby-ivar">@plugintype</span>.<span class="ruby-identifier">to_s</span>)
722 41:         <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">plugindir</span>
723 42:           <span class="ruby-identifier">plugindata</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">plugindir</span>, <span class="ruby-value str">&quot;*&quot;</span>))
724 43:         <span class="ruby-keyword kw">else</span>
725 44:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
726 45:         <span class="ruby-keyword kw">end</span>
727 46: 
728 47:         <span class="ruby-identifier">plugindata</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>,
729 48:                                       <span class="ruby-identifier">:version</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>],
730 49:                                       <span class="ruby-identifier">:revision</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@revision</span>} <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@packagedata</span>[<span class="ruby-identifier">:common</span>]
731 50:         <span class="ruby-identifier">plugindata</span>
732 51:       <span class="ruby-keyword kw">end</span></pre>
733                                         </div>
734                                         
735                                 </div>
736
737                                 
738                         </div>
739
740                 
741                 </div>
742         
743
744         </div>
745
746
747         <div id="rdoc-debugging-section-dump" class="debugging-section">
748         
749                 <p>Disabled; run with --debug to generate this.</p>
750         
751         </div>
752
753         <div id="validator-badges">
754                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
755                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
756                         Rdoc Generator</a> 1.1.6</small>.</p>
757         </div>
758
759 </body>
760 </html>
761