← Back to branch summary

~lynxman/ubuntu/quantal/mcollective/mcollective20

« back to all changes in this revision

Viewing changes to doc/classes/MCollective/PluginManager.html

  • Committer: Bazaar Package Importer
  • Author(s): Marc Cluet, Marc Cluet, Andres Rodriguez
  • Date: 2011-07-06 09:47:40 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20110706094740-x1lthyqo52rdkgad
Tags: 1.2.1-0ubuntu1
[ Marc Cluet ]
* Update to 1.2.1
* debian/control: Add Depends on ruby, rubygems, libstomp-ruby
* debian/rules: Fix permissions and remove .gitignore.
* debian/mcollective.postrm: Do not purge server.cfg.

[ Andres Rodriguez ]
* debian/patches/drop-init-script.patch: Refreshed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/classes/MCollective/PluginManager.html
87
87
      <h3 class="section-bar">Methods</h3>
88
88
 
89
89
      <div class="name-list">
90
 
      <a href="#M000045">&lt;&lt;</a>&nbsp;&nbsp;
91
 
      <a href="#M000050">[]</a>&nbsp;&nbsp;
92
 
      <a href="#M000049">clear</a>&nbsp;&nbsp;
93
 
      <a href="#M000051">create_instance</a>&nbsp;&nbsp;
94
 
      <a href="#M000046">delete</a>&nbsp;&nbsp;
95
 
      <a href="#M000053">grep</a>&nbsp;&nbsp;
96
 
      <a href="#M000047">include?</a>&nbsp;&nbsp;
97
 
      <a href="#M000052">loadclass</a>&nbsp;&nbsp;
98
 
      <a href="#M000048">pluginlist</a>&nbsp;&nbsp;
 
90
      <a href="#M000021">&lt;&lt;</a>&nbsp;&nbsp;
 
91
      <a href="#M000026">[]</a>&nbsp;&nbsp;
 
92
      <a href="#M000025">clear</a>&nbsp;&nbsp;
 
93
      <a href="#M000027">create_instance</a>&nbsp;&nbsp;
 
94
      <a href="#M000022">delete</a>&nbsp;&nbsp;
 
95
      <a href="#M000029">grep</a>&nbsp;&nbsp;
 
96
      <a href="#M000023">include?</a>&nbsp;&nbsp;
 
97
      <a href="#M000028">loadclass</a>&nbsp;&nbsp;
 
98
      <a href="#M000024">pluginlist</a>&nbsp;&nbsp;
99
99
      </div>
100
100
    </div>
101
101
 
117
117
    <div id="methods">
118
118
      <h3 class="section-bar">Public Class methods</h3>
119
119
 
120
 
      <div id="method-M000045" class="method-detail">
121
 
        <a name="M000045"></a>
 
120
      <div id="method-M000021" class="method-detail">
 
121
        <a name="M000021"></a>
122
122
 
123
123
        <div class="method-heading">
124
 
          <a href="#M000045" class="method-signature">
 
124
          <a href="#M000021" class="method-signature">
125
125
          <span class="method-name">&lt;&lt;</span><span class="method-args">(plugin)</span>
126
126
          </a>
127
127
        </div>
163
163
a copy is requested. This only works with sending a String for :class.
164
164
</p>
165
165
          <p><a class="source-toggle" href="#"
166
 
            onclick="toggleCode('M000045-source');return false;">[Source]</a></p>
167
 
          <div class="method-source-code" id="M000045-source">
 
166
            onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
 
167
          <div class="method-source-code" id="M000021-source">
168
168
<pre>
169
169
    <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 30</span>
170
170
30:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">&lt;&lt;</span>(<span class="ruby-identifier">plugin</span>)
192
192
        </div>
193
193
      </div>
194
194
 
195
 
      <div id="method-M000050" class="method-detail">
196
 
        <a name="M000050"></a>
 
195
      <div id="method-M000026" class="method-detail">
 
196
        <a name="M000026"></a>
197
197
 
198
198
        <div class="method-heading">
199
 
          <a href="#M000050" class="method-signature">
 
199
          <a href="#M000026" class="method-signature">
200
200
          <span class="method-name">[]</span><span class="method-args">(plugin)</span>
201
201
          </a>
202
202
        </div>
206
206
Gets a plugin by type
207
207
</p>
208
208
          <p><a class="source-toggle" href="#"
209
 
            onclick="toggleCode('M000050-source');return false;">[Source]</a></p>
210
 
          <div class="method-source-code" id="M000050-source">
 
209
            onclick="toggleCode('M000026-source');return false;">[Source]</a></p>
 
210
          <div class="method-source-code" id="M000026-source">
211
211
<pre>
212
212
    <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 72</span>
213
213
72:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">plugin</span>)
235
235
        </div>
236
236
      </div>
237
237
 
238
 
      <div id="method-M000049" class="method-detail">
239
 
        <a name="M000049"></a>
 
238
      <div id="method-M000025" class="method-detail">
 
239
        <a name="M000025"></a>
240
240
 
241
241
        <div class="method-heading">
242
 
          <a href="#M000049" class="method-signature">
 
242
          <a href="#M000025" class="method-signature">
243
243
          <span class="method-name">clear</span><span class="method-args">()</span>
244
244
          </a>
245
245
        </div>
249
249
deletes all registered plugins
250
250
</p>
251
251
          <p><a class="source-toggle" href="#"
252
 
            onclick="toggleCode('M000049-source');return false;">[Source]</a></p>
253
 
          <div class="method-source-code" id="M000049-source">
 
252
            onclick="toggleCode('M000025-source');return false;">[Source]</a></p>
 
253
          <div class="method-source-code" id="M000025-source">
254
254
<pre>
255
255
    <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 67</span>
256
256
67:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">clear</span>
261
261
        </div>
262
262
      </div>
263
263
 
264
 
      <div id="method-M000051" class="method-detail">
265
 
        <a name="M000051"></a>
 
264
      <div id="method-M000027" class="method-detail">
 
265
        <a name="M000027"></a>
266
266
 
267
267
        <div class="method-heading">
268
 
          <a href="#M000051" class="method-signature">
 
268
          <a href="#M000027" class="method-signature">
269
269
          <span class="method-name">create_instance</span><span class="method-args">(klass)</span>
270
270
          </a>
271
271
        </div>
275
275
use eval to create an instance of a class
276
276
</p>
277
277
          <p><a class="source-toggle" href="#"
278
 
            onclick="toggleCode('M000051-source');return false;">[Source]</a></p>
279
 
          <div class="method-source-code" id="M000051-source">
 
278
            onclick="toggleCode('M000027-source');return false;">[Source]</a></p>
 
279
          <div class="method-source-code" id="M000027-source">
280
280
<pre>
281
281
     <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 94</span>
282
282
 94:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">create_instance</span>(<span class="ruby-identifier">klass</span>)
291
291
        </div>
292
292
      </div>
293
293
 
294
 
      <div id="method-M000046" class="method-detail">
295
 
        <a name="M000046"></a>
 
294
      <div id="method-M000022" class="method-detail">
 
295
        <a name="M000022"></a>
296
296
 
297
297
        <div class="method-heading">
298
 
          <a href="#M000046" class="method-signature">
 
298
          <a href="#M000022" class="method-signature">
299
299
          <span class="method-name">delete</span><span class="method-args">(plugin)</span>
300
300
          </a>
301
301
        </div>
305
305
Removes a plugim the list
306
306
</p>
307
307
          <p><a class="source-toggle" href="#"
308
 
            onclick="toggleCode('M000046-source');return false;">[Source]</a></p>
309
 
          <div class="method-source-code" id="M000046-source">
 
308
            onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
 
309
          <div class="method-source-code" id="M000022-source">
310
310
<pre>
311
311
    <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 52</span>
312
312
52:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">plugin</span>)
317
317
        </div>
318
318
      </div>
319
319
 
320
 
      <div id="method-M000053" class="method-detail">
321
 
        <a name="M000053"></a>
 
320
      <div id="method-M000029" class="method-detail">
 
321
        <a name="M000029"></a>
322
322
 
323
323
        <div class="method-heading">
324
 
          <a href="#M000053" class="method-signature">
 
324
          <a href="#M000029" class="method-signature">
325
325
          <span class="method-name">grep</span><span class="method-args">(regex)</span>
326
326
          </a>
327
327
        </div>
331
331
Grep&#8216;s over the plugin list and returns the list found
332
332
</p>
333
333
          <p><a class="source-toggle" href="#"
334
 
            onclick="toggleCode('M000053-source');return false;">[Source]</a></p>
335
 
          <div class="method-source-code" id="M000053-source">
 
334
            onclick="toggleCode('M000029-source');return false;">[Source]</a></p>
 
335
          <div class="method-source-code" id="M000029-source">
336
336
<pre>
337
337
     <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 115</span>
338
338
115:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-identifier">regex</span>)
343
343
        </div>
344
344
      </div>
345
345
 
346
 
      <div id="method-M000047" class="method-detail">
347
 
        <a name="M000047"></a>
 
346
      <div id="method-M000023" class="method-detail">
 
347
        <a name="M000023"></a>
348
348
 
349
349
        <div class="method-heading">
350
 
          <a href="#M000047" class="method-signature">
 
350
          <a href="#M000023" class="method-signature">
351
351
          <span class="method-name">include?</span><span class="method-args">(plugin)</span>
352
352
          </a>
353
353
        </div>
357
357
Finds out if we have a plugin with the given name
358
358
</p>
359
359
          <p><a class="source-toggle" href="#"
360
 
            onclick="toggleCode('M000047-source');return false;">[Source]</a></p>
361
 
          <div class="method-source-code" id="M000047-source">
 
360
            onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
 
361
          <div class="method-source-code" id="M000023-source">
362
362
<pre>
363
363
    <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 57</span>
364
364
57:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">plugin</span>)
369
369
        </div>
370
370
      </div>
371
371
 
372
 
      <div id="method-M000052" class="method-detail">
373
 
        <a name="M000052"></a>
 
372
      <div id="method-M000028" class="method-detail">
 
373
        <a name="M000028"></a>
374
374
 
375
375
        <div class="method-heading">
376
 
          <a href="#M000052" class="method-signature">
 
376
          <a href="#M000028" class="method-signature">
377
377
          <span class="method-name">loadclass</span><span class="method-args">(klass)</span>
378
378
          </a>
379
379
        </div>
384
384
and then doing a require.
385
385
</p>
386
386
          <p><a class="source-toggle" href="#"
387
 
            onclick="toggleCode('M000052-source');return false;">[Source]</a></p>
388
 
          <div class="method-source-code" id="M000052-source">
 
387
            onclick="toggleCode('M000028-source');return false;">[Source]</a></p>
 
388
          <div class="method-source-code" id="M000028-source">
389
389
<pre>
390
390
     <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 104</span>
391
391
104:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-identifier">klass</span>)
402
402
        </div>
403
403
      </div>
404
404
 
405
 
      <div id="method-M000048" class="method-detail">
406
 
        <a name="M000048"></a>
 
405
      <div id="method-M000024" class="method-detail">
 
406
        <a name="M000024"></a>
407
407
 
408
408
        <div class="method-heading">
409
 
          <a href="#M000048" class="method-signature">
 
409
          <a href="#M000024" class="method-signature">
410
410
          <span class="method-name">pluginlist</span><span class="method-args">()</span>
411
411
          </a>
412
412
        </div>
416
416
Provides a list of plugins we know about
417
417
</p>
418
418
          <p><a class="source-toggle" href="#"
419
 
            onclick="toggleCode('M000048-source');return false;">[Source]</a></p>
420
 
          <div class="method-source-code" id="M000048-source">
 
419
            onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
 
420
          <div class="method-source-code" id="M000024-source">
421
421
<pre>
422
422
    <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 62</span>
423
423
62:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">pluginlist</span>