-mcollective (2.3.2-1) unstable; urgency=low
+mcollective (2.3.3-1puppetlabs1) unstable sid squeeze wheezy precise; urgency=low
- * Automated release for 2.3.2-1 by rake deb
+ * Update to version 2.3.3-1puppetlabs1
- See http://marionette-collective.org/releasenotes.html for full details
-
- -- The Marionette Collective <mcollective-dev@googlegroups.com> Fri, 08 Nov 2013 12:58:34 +0000
+ -- Puppet Labs Release <info@puppetlabs.com> Fri, 15 Nov 2013 12:53:51 +0000
Section: utils
Priority: extra
Maintainer: Riccardo Setti <giskard@debian.org>
-Build-Depends: debhelper (>= 7), dpatch, cdbs
+Build-Depends: debhelper (>= 7), quilt, cdbs, ruby
Standards-Version: 3.8.0
Homepage: http://marionette-collective.org/
Architecture: all
Depends: ruby (>= 1.8.1), mcollective-common (= ${source:Version})
Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
+ The Marionette Collective aka. mcollective is a framework
to build server orchestration or parallel job execution systems.
Package: mcollective-client
Architecture: all
Depends: ruby (>= 1.8.1), mcollective-common (= ${source:Version})
Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
+ The Marionette Collective aka. mcollective is a framework
to build server orchestration or parallel job execution system
Package: mcollective-common
Architecture: all
Depends: ruby (>= 1.8.1) , rubygems, ruby-stomp | libstomp-ruby
Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
+ The Marionette Collective aka. mcollective is a framework
to build server orchestration or parallel job execution systems.
.
Common files for mcollective packages.
Architecture: all
Section: doc
Description: Documentation for mcollective
- The Marionette Collective aka. mcollective is a framework
+ The Marionette Collective aka. mcollective is a framework
to build server orchestration or parallel job execution systems.
.
Documentation package.
+++ /dev/null
-usr/lib/ruby/vendor_ruby
--- /dev/null
+etc/mcollective/ssl/clients
+etc/mcollective/plugin.d
$0 start
fi
;;
+ force-reload)
+ echo "not implemented"
+ ;;
status)
status_of_proc -p ${pidfile} ${mcollectived} ${name} && exit 0 || exit $?
;;
-usr/sbin/mcollectived usr/sbin
-etc/mcollective/facts.yaml etc/mcollective
-etc/mcollective/server.cfg etc/mcollective
-etc/init.d etc/
-etc/mcollective/ssl
+usr/sbin/mcollectived
+etc/mcollective/facts.yaml
+etc/mcollective/server.cfg
+++ /dev/null
-pluginsdir.dpatch
+++ /dev/null
-#! /bin/sh /usr/share/dpatch/dpatch-run
-## conffile.dpatch by <giskard@debian.org
-##
-## All lines beginning with `## DP:' are a description of the patch.
-## DP: default config options
-
-@DPATCH@
-diff -urNad mcollective-0.4.1~/etc/client.cfg mcollective-0.4.1/etc/client.cfg
---- mcollective-0.4.1~/etc/client.cfg 1970-01-01 00:00:00.000000000 +0000
-+++ mcollective-0.4.1/etc/client.cfg 2010-01-06 14:37:24.000000000 +0000
-@@ -0,0 +1,19 @@
-+libdir = /usr/share/mcollective/plugins
-+logger_type = console
-+loglevel = warn
-+
-+# Plugins
-+securityprovider = psk
-+plugin.psk = unset
-+
-+connector = activemq
-+plugin.activemq.pool.size = 1
-+plugin.activemq.pool.1.host = stomp1
-+plugin.activemq.pool.1.port = 6163
-+plugin.activemq.pool.1.user = mcollective
-+plugin.activemq.pool.1.password = marionette
-+
-+# Facts
-+factsource = yaml
-+plugin.yaml = /etc/mcollective/facts.yaml
-+
-diff -urNad mcollective-0.4.1~/etc/client.cfg.dist mcollective-0.4.1/etc/client.cfg.dist
---- mcollective-0.4.1~/etc/client.cfg.dist 2010-01-02 14:54:25.000000000 +0000
-+++ mcollective-0.4.1/etc/client.cfg.dist 1970-01-01 00:00:00.000000000 +0000
-@@ -1,19 +0,0 @@
--libdir = /usr/libexec/mcollective
--logger_type = console
--loglevel = warn
--
--# Plugins
--securityprovider = psk
--plugin.psk = unset
--
--connector = stomp
--plugin.stomp.host = stomp.your.com
--plugin.stomp.port = 6163
--plugin.stomp.user = mcollective
--plugin.stomp.password = marionette
--
--# Facts
--factsource = yaml
--plugin.yaml = /etc/mcollective/facts.yaml
--
-diff -urNad mcollective-0.4.1~/etc/facts.yaml mcollective-0.4.1/etc/facts.yaml
---- mcollective-0.4.1~/etc/facts.yaml 1970-01-01 00:00:00.000000000 +0000
-+++ mcollective-0.4.1/etc/facts.yaml 2010-01-06 14:37:27.000000000 +0000
-@@ -0,0 +1,2 @@
-+---
-+mcollective: 1
-diff -urNad mcollective-0.4.1~/etc/facts.yaml.dist mcollective-0.4.1/etc/facts.yaml.dist
---- mcollective-0.4.1~/etc/facts.yaml.dist 2010-01-02 14:54:25.000000000 +0000
-+++ mcollective-0.4.1/etc/facts.yaml.dist 1970-01-01 00:00:00.000000000 +0000
-@@ -1,2 +0,0 @@
-----
--mcollective: 1
-diff -urNad mcollective-0.4.1~/etc/server.cfg mcollective-0.4.1/etc/server.cfg
---- mcollective-0.4.1~/etc/server.cfg 1970-01-01 00:00:00.000000000 +0000
-+++ mcollective-0.4.1/etc/server.cfg 2010-01-06 14:37:50.000000000 +0000
-@@ -0,0 +1,20 @@
-+libdir = /usr/share/mcollective/plugins
-+logfile = /var/log/mcollective.log
-+loglevel = info
-+daemonize = 1
-+
-+# Plugins
-+securityprovider = psk
-+plugin.psk = unset
-+
-+connector = activemq
-+plugin.activemq.pool.size = 1
-+plugin.activemq.pool.1.host = stomp1
-+plugin.activemq.pool.1.port = 6163
-+plugin.activemq.pool.1.user = mcollective
-+plugin.activemq.pool.1.password = marionette
-+
-+# Facts
-+factsource = yaml
-+plugin.yaml = /etc/mcollective/facts.yaml
-+
-diff -urNad mcollective-0.4.1~/etc/server.cfg.dist mcollective-0.4.1/etc/server.cfg.dist
---- mcollective-0.4.1~/etc/server.cfg.dist 2010-01-02 14:54:25.000000000 +0000
-+++ mcollective-0.4.1/etc/server.cfg.dist 1970-01-01 00:00:00.000000000 +0000
-@@ -1,20 +0,0 @@
--libdir = /usr/libexec/mcollective
--logfile = /var/log/mcollective.log
--loglevel = info
--daemonize = 1
--
--# Plugins
--securityprovider = psk
--plugin.psk = unset
--
--connector = stomp
--plugin.stomp.host = stomp.your.com
--plugin.stomp.port = 6163
--plugin.stomp.user = mcollective
--plugin.stomp.password = marionette
--
--# Facts
--factsource = yaml
--plugin.yaml = /etc/mcollective/facts.yaml
--
+++ /dev/null
-#! /bin/sh /usr/share/dpatch/dpatch-run
-## initlsb.dpatch by <giskard@debian.org
-##
-## All lines beginning with `## DP:' are a description of the patch.
-## DP: Init func.
-
-@DPATCH@
-diff -urNad mcollective-0.4.1~/mcollective.init mcollective-0.4.1/mcollective.init
---- mcollective-0.4.1~/mcollective.init 2010-01-02 14:54:25.000000000 +0000
-+++ mcollective-0.4.1/mcollective.init 2010-01-07 10:52:38.000000000 +0000
-@@ -8,6 +8,15 @@
- # much about all the setup and management of a Stomp connection, it also provides stats, logging and so forth
- # as a bonus.
- #
-+### BEGIN INIT INFO
-+# Provides: scriptname
-+# Required-Start: $remote_fs $syslog
-+# Required-Stop: $remote_fs $syslog
-+# Default-Start: 2 3 4 5
-+# Default-Stop: 0 1 6
-+# Short-Description: Start daemon at boot time
-+# Description: Enable service provided by daemon.
-+### END INIT INFO
-
- RUBYLIB=/usr/local/lib/site_ruby/1.8:$RUBYLIB
- export RUBYLIB
-@@ -104,7 +113,10 @@
- echo "mcollectived: service not started"
- exit 1
- fi
-- ;;
-+ ;;
-+ force-reload)
-+ echo "not implemented"
-+ ;;
- *)
- echo "Usage: mcollectived {start|stop|restart|condrestart|status}"
- exit 1
+++ /dev/null
-#! /bin/sh /usr/share/dpatch/dpatch-run
-## makefile.dpatch by <giskard@debian.org
-##
-## All lines beginning with `## DP:' are a description of the patch.
-## DP: Add Makefile for install task
-
-@DPATCH@
-diff -urNad mcollective-0.4.1~/Makefile mcollective-0.4.1/Makefile
---- mcollective-0.4.1~/Makefile 1970-01-01 00:00:00.000000000 +0000
-+++ mcollective-0.4.1/Makefile 2010-01-06 13:43:56.000000000 +0000
-@@ -0,0 +1,38 @@
-+#!/usr/bin/make -f
-+
-+DESTDIR=
-+
-+clean:
-+
-+install: install-bin install-lib install-conf install-plugins install-doc
-+
-+install-bin:
-+ install -d $(DESTDIR)/usr/sbin
-+ cp mc-* $(DESTDIR)/usr/sbin
-+ cp mcollectived.rb $(DESTDIR)/usr/sbin/mcollectived
-+
-+install-lib:
-+ install -d $(DESTDIR)/usr/lib/ruby/vendor_ruby/
-+ cp -a lib/* $(DESTDIR)/usr/lib/ruby/vendor_ruby/
-+
-+install-conf:
-+ install -d $(DESTDIR)/etc/mcollective/
-+ install -d $(DESTDIR)/etc/init.d
-+ cp etc/* $(DESTDIR)/etc/mcollective/
-+ cp mcollective.init $(DESTDIR)/etc/init.d/mcollective
-+
-+install-plugins:
-+ install -d $(DESTDIR)/usr/share/mcollective/
-+ cp -a plugins $(DESTDIR)/usr/share/mcollective/
-+
-+install-doc:
-+ install -d $(DESTDIR)/usr/share/doc/
-+ cp -a doc $(DESTDIR)/usr/share/doc/mcollective
-+
-+uninstall:
-+ rm -f $(DESTDIR)/usr/sbin/mcollectived
-+ rm -rf $(DESTDIR)/usr/lib/ruby/vendor_ruby/mcollective*
-+ rm -rf $(DESTDIR)/usr/share/mcollective
-+ rm -rf $(DESTDIR)/etc/mcollective
-+
-+.PHONY: clean install uninstall
+++ /dev/null
-#! /bin/sh /usr/share/dpatch/dpatch-run
-## pluginsdir.dpatch by <gisakrd@debian.org>
-##
-## All lines beginning with `## DP:' are a description of the patch.
-## DP: fix plugins dir
-
-@DPATCH@
-diff -urNad mcollective-1.1.4~/etc/client.cfg.dist mcollective-1.1.4/etc/client.cfg.dist
---- mcollective-1.1.4~/etc/client.cfg.dist 2011-04-06 14:13:08.829462165 -0700
-+++ mcollective-1.1.4/etc/client.cfg.dist 2011-04-06 14:12:53.129384114 -0700
-@@ -1,6 +1,6 @@
- main_collective = mcollective
- collectives = mcollective
--libdir = /usr/libexec/mcollective
-+libdir = /usr/share/mcollective/plugins
- logger_type = console
- loglevel = warn
-
-diff -urNad mcollective-1.1.4~/etc/server.cfg.dist mcollective-1.1.4/etc/server.cfg.dist
---- mcollective-1.1.4~/etc/server.cfg.dist 2011-04-06 14:12:30.889527230 -0700
-+++ mcollective-1.1.4/etc/server.cfg.dist 2011-04-06 14:12:23.779407065 -0700
-@@ -1,6 +1,6 @@
- main_collective = mcollective
- collectives = mcollective
--libdir = /usr/libexec/mcollective
-+libdir = /usr/share/mcollective/plugins
- logfile = /var/log/mcollective.log
- loglevel = info
- daemonize = 1
-
--- /dev/null
+diff --git a/etc/client.cfg.dist b/etc/client.cfg.dist
+index 1acffee..5c36486 100644
+--- a/etc/client.cfg.dist
++++ b/etc/client.cfg.dist
+@@ -1,6 +1,6 @@
+ main_collective = mcollective
+ collectives = mcollective
+-libdir = /usr/libexec/mcollective
++libdir = /usr/share/mcollective/plugins
+ logger_type = console
+ loglevel = warn
+
+diff --git a/etc/server.cfg.dist b/etc/server.cfg.dist
+index 2038324..c28a826 100644
+--- a/etc/server.cfg.dist
++++ b/etc/server.cfg.dist
+@@ -1,6 +1,6 @@
+ main_collective = mcollective
+ collectives = mcollective
+-libdir = /usr/libexec/mcollective
++libdir = /usr/share/mcollective/plugins
+ logfile = /var/log/mcollective.log
+ loglevel = info
+ daemonize = 1
--- /dev/null
+pluginsdir.patch
#!/usr/bin/make -f
-DEB_MAKE_CLEAN_TARGET :=
-DEB_MAKE_INSTALL_TARGET := install DESTDIR=$(CURDIR)/debian/tmp
-
include /usr/share/cdbs/1/rules/debhelper.mk
-include /usr/share/cdbs/1/rules/dpatch.mk
-include /usr/share/cdbs/1/class/makefile.mk
-DEB_MAKE_INVOKE = $(DEB_MAKE_ENVVARS) make -f ext/Makefile.debian -C $(DEB_BUILDDIR)
+BUILD_ROOT=$(CURDIR)/debian/tmp
+RUBY_LIBDIR=$(shell /usr/bin/ruby -rrbconfig -e 'puts RbConfig::CONFIG["vendordir"]')
+PLUGINDIR=/usr/share/mcollective/plugins
+DOCDIR=$(BUILD_ROOT)/usr/share/doc/mcollective
install/mcollective::
- mv $(CURDIR)/debian/tmp/etc/mcollective/server.cfg.dist $(CURDIR)/debian/tmp/etc/mcollective/server.cfg
- mv $(CURDIR)/debian/tmp/etc/mcollective/client.cfg.dist $(CURDIR)/debian/tmp/etc/mcollective/client.cfg
- mv $(CURDIR)/debian/tmp/etc/mcollective/facts.yaml.dist $(CURDIR)/debian/tmp/etc/mcollective/facts.yaml
-# dh_installinit -pmcollective -o
+ /usr/bin/ruby install.rb --destdir=$(CURDIR)/debian/tmp --no-rdoc --sitelibdir=$(RUBY_LIBDIR) --ruby=/usr/bin/ruby --plugindir=$(PLUGINDIR)
+ mkdir -p $(DOCDIR)
+ cp -a doc/* $(DOCDIR)
binary-fixup/mcollective::
chmod 640 $(CURDIR)/debian/mcollective/etc/mcollective/server.cfg
--- /dev/null
+3.0 (quilt)
--- /dev/null
+<?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: Array</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/monkey_patches_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/monkey_patches.rb">lib/mcollective/monkey_patches.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="#M000200">#in_groups_of</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">Array</h1>
+
+ <div id="description">
+ <p>
+a method # that walks an array in groups, pass a block to call the block on
+each sub array
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="in-groups-of-method" class="method-detail ">
+ <a name="M000200"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">in_groups_of</span><span
+ class="method-args">(chunk_size, padded_with=nil, &block)</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="in-groups-of-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 29</span>
+29: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">in_groups_of</span>(<span class="ruby-identifier">chunk_size</span>, <span class="ruby-identifier">padded_with</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+30: <span class="ruby-identifier">arr</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">clone</span>
+31:
+32: <span class="ruby-comment cmt"># how many to add</span>
+33: <span class="ruby-identifier">padding</span> = <span class="ruby-identifier">chunk_size</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">arr</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">chunk_size</span>)
+34:
+35: <span class="ruby-comment cmt"># pad at the end</span>
+36: <span class="ruby-identifier">arr</span>.<span class="ruby-identifier">concat</span>([<span class="ruby-identifier">padded_with</span>] <span class="ruby-operator">*</span> <span class="ruby-identifier">padding</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">padding</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">chunk_size</span>
+37:
+38: <span class="ruby-comment cmt"># how many chunks we'll make</span>
+39: <span class="ruby-identifier">count</span> = <span class="ruby-identifier">arr</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">chunk_size</span>
+40:
+41: <span class="ruby-comment cmt"># make that many arrays</span>
+42: <span class="ruby-identifier">result</span> = []
+43: <span class="ruby-identifier">count</span>.<span class="ruby-identifier">times</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">arr</span>[<span class="ruby-identifier">s</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">chunk_size</span>, <span class="ruby-identifier">chunk_size</span>]}
+44:
+45: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+46: <span class="ruby-identifier">result</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">a</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
+47: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">arity</span>
+48: <span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span>
+49: <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">a</span>)
+50: <span class="ruby-keyword kw">when</span> <span class="ruby-value">2</span>
+51: <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">a</span>, (<span class="ruby-identifier">i</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>))
+52: <span class="ruby-keyword kw">else</span>
+53: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Expected 1 or 2 arguments, got #{block.arity}"</span>
+54: <span class="ruby-keyword kw">end</span>
+55: <span class="ruby-keyword kw">end</span>
+56: <span class="ruby-keyword kw">else</span>
+57: <span class="ruby-identifier">result</span>
+58: <span class="ruby-keyword kw">end</span>
+59: <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>
+
--- /dev/null
+<?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>File: COPYING [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <pre>
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+</pre>
+<p>
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+</p>
+<ol>
+<li>Definitions.
+
+<p>
+“License” shall mean the terms and conditions for use,
+reproduction, and distribution as defined by Sections 1 through 9 of this
+document.
+</p>
+<p>
+“Licensor” shall mean the copyright owner or entity authorized
+by the copyright owner that is granting the License.
+</p>
+<p>
+“Legal Entity” shall mean the union of the acting entity and
+all other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+“control” means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or otherwise,
+or (ii) ownership of fifty percent (50%) or more of the outstanding shares,
+or (iii) beneficial ownership of such entity.
+</p>
+<p>
+“You” (or “Your”) shall mean an individual or Legal
+Entity exercising permissions granted by this License.
+</p>
+<p>
+“Source” form shall mean the preferred form for making
+modifications, including but not limited to software source code,
+documentation source, and configuration files.
+</p>
+<p>
+“Object” form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but not limited
+to compiled object code, generated documentation, and conversions to other
+media types.
+</p>
+<p>
+“Work” shall mean the work of authorship, whether in Source or
+<a href="Object.html">Object</a> form, made available under the License, as
+indicated by a copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+</p>
+<p>
+“Derivative Works” shall mean any work, whether in Source or <a
+href="Object.html">Object</a> form, that is based on (or derived from) the
+Work and for which the editorial revisions, annotations, elaborations, or
+other modifications represent, as a whole, an original work of authorship.
+For the purposes of this License, Derivative Works shall not include works
+that remain separable from, or merely link (or bind by name) to the
+interfaces of, the Work and Derivative Works thereof.
+</p>
+<p>
+“Contribution” shall mean any work of authorship, including the
+original version of the Work and any modifications or additions to that
+Work or Derivative Works thereof, that is intentionally submitted to
+Licensor for inclusion in the Work by the copyright owner or by an
+individual or Legal Entity authorized to submit on behalf of the copyright
+owner. For the purposes of this definition, “submitted” means
+any form of electronic, verbal, or written communication sent to the
+Licensor or its representatives, including but not limited to communication
+on electronic mailing lists, source code control systems, and issue
+tracking systems that are managed by, or on behalf of, the Licensor for the
+purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the
+copyright owner as “Not a Contribution.“
+</p>
+<p>
+“Contributor” shall mean Licensor and any individual or Legal
+Entity on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+</p>
+</li>
+<li>Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+<a href="Object.html">Object</a> form.
+
+</li>
+<li>Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in
+this section) patent license to make, have made, use, offer to sell, sell,
+import, and otherwise transfer the Work, where such license applies only to
+those patent claims licensable by such Contributor that are necessarily
+infringed by their Contribution(s) alone or by combination of their
+Contribution(s) with the Work to which such Contribution(s) was submitted.
+If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or
+contributory patent infringement, then any patent licenses granted to You
+under this License for that Work shall terminate as of the date such
+litigation is filed.
+
+</li>
+<li>Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and
+in Source or <a href="Object.html">Object</a> form, provided that You meet
+the following conditions:
+
+<p>
+(a) You must give any other recipients of the Work or
+</p>
+<pre>
+ Derivative Works a copy of this License; and
+</pre>
+<p>
+(b) You must cause any modified files to carry prominent notices
+</p>
+<pre>
+ stating that You changed the files; and
+</pre>
+<p>
+© You must retain, in the Source form of any Derivative Works
+</p>
+<pre>
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+</pre>
+<p>
+(d) If the Work includes a “NOTICE” text file as part of its
+</p>
+<pre>
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+</pre>
+<p>
+You may add Your own copyright statement to Your modifications and may
+provide additional or different license terms and conditions for use,
+reproduction, or distribution of Your modifications, or for any such
+Derivative Works as a whole, provided Your use, reproduction, and
+distribution of the Work otherwise complies with the conditions stated in
+this License.
+</p>
+</li>
+<li>Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to
+the Licensor shall be under the terms and conditions of this License,
+without any additional terms or conditions. Notwithstanding the above,
+nothing herein shall supersede or modify the terms of any separate license
+agreement you may have executed with Licensor regarding such Contributions.
+
+</li>
+<li>Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as
+required for reasonable and customary use in describing the origin of the
+Work and reproducing the content of the NOTICE file.
+
+</li>
+<li>Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an “AS IS” BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied, including, without
+limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
+MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely
+responsible for determining the appropriateness of using or redistributing
+the Work and assume any risks associated with Your exercise of permissions
+under this License.
+
+</li>
+<li>Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to
+in writing, shall any Contributor be liable to You for damages, including
+any direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or
+inability to use the Work (including but not limited to damages for loss of
+goodwill, work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor has been
+advised of the possibility of such damages.
+
+</li>
+<li>Accepting Warranty or Additional Liability. While redistributing the Work
+or Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any
+liability incurred by, or claims asserted against, such Contributor by
+reason of your accepting any such warranty or additional liability.
+
+</li>
+</ol>
+<p>
+END OF TERMS AND CONDITIONS
+</p>
+<p>
+APPENDIX: How to apply the Apache License to your work.
+</p>
+<pre>
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+</pre>
+<p>
+Copyright 2010, 2011 Puppet Labs
+</p>
+<p>
+Licensed under the Apache License, Version 2.0 (the “License”);
+you may not use this file except in compliance with the License. You may
+obtain a copy of the License at
+</p>
+<pre>
+ http://www.apache.org/licenses/LICENSE-2.0
+</pre>
+<p>
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an “AS IS”
+BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the License for the specific language governing permissions
+and limitations under the License.
+</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>
+
--- /dev/null
+<?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: Dir</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/monkey_patches_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/monkey_patches.rb">lib/mcollective/monkey_patches.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="#M000203">::mktmpdir</a></li>
+
+ <li><a href="#M000204">::tmpdir</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">Dir</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="mktmpdir-method" class="method-detail ">
+ <a name="M000203"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">mktmpdir</span><span
+ class="method-args">(prefix_suffix=nil, tmpdir=nil)</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="mktmpdir-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 72</span>
+ 72: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">mktmpdir</span>(<span class="ruby-identifier">prefix_suffix</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">tmpdir</span>=<span class="ruby-keyword kw">nil</span>)
+ 73: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">prefix_suffix</span>
+ 74: <span class="ruby-keyword kw">when</span> <span class="ruby-keyword kw">nil</span>
+ 75: <span class="ruby-identifier">prefix</span> = <span class="ruby-value str">"d"</span>
+ 76: <span class="ruby-identifier">suffix</span> = <span class="ruby-value str">""</span>
+ 77: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">String</span>
+ 78: <span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">prefix_suffix</span>
+ 79: <span class="ruby-identifier">suffix</span> = <span class="ruby-value str">""</span>
+ 80: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Array</span>
+ 81: <span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">prefix_suffix</span>[<span class="ruby-value">0</span>]
+ 82: <span class="ruby-identifier">suffix</span> = <span class="ruby-identifier">prefix_suffix</span>[<span class="ruby-value">1</span>]
+ 83: <span class="ruby-keyword kw">else</span>
+ 84: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"unexpected prefix_suffix: #{prefix_suffix.inspect}"</span>
+ 85: <span class="ruby-keyword kw">end</span>
+ 86: <span class="ruby-identifier">tmpdir</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">tmpdir</span>
+ 87: <span class="ruby-identifier">t</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">"%Y%m%d"</span>)
+ 88: <span class="ruby-identifier">n</span> = <span class="ruby-keyword kw">nil</span>
+ 89: <span class="ruby-keyword kw">begin</span>
+ 90: <span class="ruby-identifier">path</span> = <span class="ruby-node">"#{tmpdir}/#{prefix}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"</span>
+ 91: <span class="ruby-identifier">path</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"-#{n}"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">n</span>
+ 92: <span class="ruby-identifier">path</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">suffix</span>
+ 93: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span>(<span class="ruby-identifier">path</span>, <span class="ruby-value">0700</span>)
+ 94: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EEXIST</span>
+ 95: <span class="ruby-identifier">n</span> <span class="ruby-operator">||=</span> <span class="ruby-value">0</span>
+ 96: <span class="ruby-identifier">n</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+ 97: <span class="ruby-keyword kw">retry</span>
+ 98: <span class="ruby-keyword kw">end</span>
+ 99:
+100: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+101: <span class="ruby-keyword kw">begin</span>
+102: <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">path</span>
+103: <span class="ruby-keyword kw">ensure</span>
+104: <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">remove_entry_secure</span> <span class="ruby-identifier">path</span>
+105: <span class="ruby-keyword kw">end</span>
+106: <span class="ruby-keyword kw">else</span>
+107: <span class="ruby-identifier">path</span>
+108: <span class="ruby-keyword kw">end</span>
+109: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="tmpdir-method" class="method-detail ">
+ <a name="M000204"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">tmpdir</span><span
+ class="method-args">()</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="tmpdir-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 111</span>
+111: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">tmpdir</span>
+112: <span class="ruby-identifier">tmp</span> = <span class="ruby-value str">'.'</span>
+113: <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">dir</span> <span class="ruby-keyword kw">in</span> [<span class="ruby-constant">ENV</span>[<span class="ruby-value str">'TMPDIR'</span>], <span class="ruby-constant">ENV</span>[<span class="ruby-value str">'TMP'</span>], <span class="ruby-constant">ENV</span>[<span class="ruby-value str">'TEMP'</span>], <span class="ruby-value str">'/tmp'</span>]
+114: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">dir</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">stat</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">stat</span>(<span class="ruby-identifier">dir</span>) <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">stat</span>.<span class="ruby-identifier">directory?</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">stat</span>.<span class="ruby-identifier">writable?</span>
+115: <span class="ruby-identifier">tmp</span> = <span class="ruby-identifier">dir</span>
+116: <span class="ruby-keyword kw">break</span>
+117: <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
+118: <span class="ruby-keyword kw">end</span>
+119: <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">tmp</span>)
+120: <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>
+
--- /dev/null
+<?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>File: Gemfile [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+source ‘<a href="https://rubygems.org">rubygems.org</a>‘
+</p>
+<p>
+gem ‘json’ gem ‘stomp’ gem ‘systemu’
+</p>
+<p>
+group :dev do
+</p>
+<pre>
+ gem 'rake'
+</pre>
+<p>
+end
+</p>
+<p>
+group :test do
+</p>
+<pre>
+ gem 'rdoc'
+ gem 'rspec', '~> 2.11.0'
+ gem 'mocha', '~> 0.10.0'
+ gem 'mcollective-test'
+</pre>
+<p>
+end
+</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>
+
--- /dev/null
+<?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>Module: MCollective</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="module">
+
+ <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_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective.rb">lib/mcollective.rb</a></li>
+
+ <li><a href="./lib/mcollective/application_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/application.rb">lib/mcollective/application.rb</a></li>
+
+ <li><a href="./lib/mcollective/optionparser_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/optionparser.rb">lib/mcollective/optionparser.rb</a></li>
+
+ <li><a href="./lib/mcollective/pluginpackager_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/pluginpackager.rb">lib/mcollective/pluginpackager.rb</a></li>
+
+ <li><a href="./lib/mcollective/matcher/scanner_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/matcher/scanner.rb">lib/mcollective/matcher/scanner.rb</a></li>
+
+ <li><a href="./lib/mcollective/matcher/parser_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/matcher/parser.rb">lib/mcollective/matcher/parser.rb</a></li>
+
+ <li><a href="./lib/mcollective/matcher_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/matcher.rb">lib/mcollective/matcher.rb</a></li>
+
+ <li><a href="./lib/mcollective/message_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/message.rb">lib/mcollective/message.rb</a></li>
+
+ <li><a href="./lib/mcollective/runner_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/runner.rb">lib/mcollective/runner.rb</a></li>
+
+ <li><a href="./lib/mcollective/pluginmanager_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/pluginmanager.rb">lib/mcollective/pluginmanager.rb</a></li>
+
+ <li><a href="./lib/mcollective/security_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/security.rb">lib/mcollective/security.rb</a></li>
+
+ <li><a href="./lib/mcollective/connector_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/connector.rb">lib/mcollective/connector.rb</a></li>
+
+ <li><a href="./lib/mcollective/pluginpackager/standard_definition_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/pluginpackager/standard_definition.rb">lib/mcollective/pluginpackager/standard_definition.rb</a></li>
+
+ <li><a href="./lib/mcollective/pluginpackager/agent_definition_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/pluginpackager/agent_definition.rb">lib/mcollective/pluginpackager/agent_definition.rb</a></li>
+
+ <li><a href="./lib/mcollective/applications_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/applications.rb">lib/mcollective/applications.rb</a></li>
+
+ <li><a href="./lib/mcollective/logger_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger.rb">lib/mcollective/logger.rb</a></li>
+
+ <li><a href="./lib/mcollective/agents_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/agents.rb">lib/mcollective/agents.rb</a></li>
+
+ <li><a href="./lib/mcollective/config_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/config.rb">lib/mcollective/config.rb</a></li>
+
+ <li><a href="./lib/mcollective/log_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/log.rb">lib/mcollective/log.rb</a></li>
+
+ <li><a href="./lib/mcollective/agent_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/agent.rb">lib/mcollective/agent.rb</a></li>
+
+ <li><a href="./lib/mcollective/aggregate_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate.rb">lib/mcollective/aggregate.rb</a></li>
+
+ <li><a href="./lib/mcollective/discovery_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/discovery.rb">lib/mcollective/discovery.rb</a></li>
+
+ <li><a href="./lib/mcollective/registration/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/registration/base.rb">lib/mcollective/registration/base.rb</a></li>
+
+ <li><a href="./lib/mcollective/registration_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/registration.rb">lib/mcollective/registration.rb</a></li>
+
+ <li><a href="./lib/mcollective/logger/console_logger_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger/console_logger.rb">lib/mcollective/logger/console_logger.rb</a></li>
+
+ <li><a href="./lib/mcollective/logger/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger/base.rb">lib/mcollective/logger/base.rb</a></li>
+
+ <li><a href="./lib/mcollective/logger/syslog_logger_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger/syslog_logger.rb">lib/mcollective/logger/syslog_logger.rb</a></li>
+
+ <li><a href="./lib/mcollective/logger/file_logger_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger/file_logger.rb">lib/mcollective/logger/file_logger.rb</a></li>
+
+ <li><a href="./lib/mcollective/data/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/data/base.rb">lib/mcollective/data/base.rb</a></li>
+
+ <li><a href="./lib/mcollective/data/result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/data/result.rb">lib/mcollective/data/result.rb</a></li>
+
+ <li><a href="./lib/mcollective/ssl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ssl.rb">lib/mcollective/ssl.rb</a></li>
+
+ <li><a href="./lib/mcollective/runnerstats_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/runnerstats.rb">lib/mcollective/runnerstats.rb</a></li>
+
+ <li><a href="./lib/mcollective/translatable_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/translatable.rb">lib/mcollective/translatable.rb</a></li>
+
+ <li><a href="./lib/mcollective/generators/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/generators/base.rb">lib/mcollective/generators/base.rb</a></li>
+
+ <li><a href="./lib/mcollective/generators/data_generator_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/generators/data_generator.rb">lib/mcollective/generators/data_generator.rb</a></li>
+
+ <li><a href="./lib/mcollective/generators/agent_generator_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/generators/agent_generator.rb">lib/mcollective/generators/agent_generator.rb</a></li>
+
+ <li><a href="./lib/mcollective/aggregate/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/base.rb">lib/mcollective/aggregate/base.rb</a></li>
+
+ <li><a href="./lib/mcollective/aggregate/result/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result/base.rb">lib/mcollective/aggregate/result/base.rb</a></li>
+
+ <li><a href="./lib/mcollective/aggregate/result/collection_result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result/collection_result.rb">lib/mcollective/aggregate/result/collection_result.rb</a></li>
+
+ <li><a href="./lib/mcollective/aggregate/result/numeric_result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result/numeric_result.rb">lib/mcollective/aggregate/result/numeric_result.rb</a></li>
+
+ <li><a href="./lib/mcollective/aggregate/result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result.rb">lib/mcollective/aggregate/result.rb</a></li>
+
+ <li><a href="./lib/mcollective/ddl/discoveryddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/discoveryddl.rb">lib/mcollective/ddl/discoveryddl.rb</a></li>
+
+ <li><a href="./lib/mcollective/facts/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/facts/base.rb">lib/mcollective/facts/base.rb</a></li>
+
+ <li><a href="./lib/mcollective/ddl/validatorddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/validatorddl.rb">lib/mcollective/ddl/validatorddl.rb</a></li>
+
+ <li><a href="./lib/mcollective/ddl/agentddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/agentddl.rb">lib/mcollective/ddl/agentddl.rb</a></li>
+
+ <li><a href="./lib/mcollective/ddl/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/base.rb">lib/mcollective/ddl/base.rb</a></li>
+
+ <li><a href="./lib/mcollective/ddl/dataddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/dataddl.rb">lib/mcollective/ddl/dataddl.rb</a></li>
+
+ <li><a href="./lib/mcollective/connector/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/connector/base.rb">lib/mcollective/connector/base.rb</a></li>
+
+ <li><a href="./lib/mcollective/util_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/util.rb">lib/mcollective/util.rb</a></li>
+
+ <li><a href="./lib/mcollective/rpc_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc.rb">lib/mcollective/rpc.rb</a></li>
+
+ <li><a href="./lib/mcollective/validator_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/validator.rb">lib/mcollective/validator.rb</a></li>
+
+ <li><a href="./lib/mcollective/cache_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/cache.rb">lib/mcollective/cache.rb</a></li>
+
+ <li><a href="./lib/mcollective/unix_daemon_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/unix_daemon.rb">lib/mcollective/unix_daemon.rb</a></li>
+
+ <li><a href="./lib/mcollective/windows_daemon_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/windows_daemon.rb">lib/mcollective/windows_daemon.rb</a></li>
+
+ <li><a href="./lib/mcollective/security/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/security/base.rb">lib/mcollective/security/base.rb</a></li>
+
+ <li><a href="./lib/mcollective/shell_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/shell.rb">lib/mcollective/shell.rb</a></li>
+
+ <li><a href="./lib/mcollective/ddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl.rb">lib/mcollective/ddl.rb</a></li>
+
+ <li><a href="./lib/mcollective/rpc/actionrunner_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/actionrunner.rb">lib/mcollective/rpc/actionrunner.rb</a></li>
+
+ <li><a href="./lib/mcollective/rpc/reply_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/reply.rb">lib/mcollective/rpc/reply.rb</a></li>
+
+ <li><a href="./lib/mcollective/rpc/progress_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/progress.rb">lib/mcollective/rpc/progress.rb</a></li>
+
+ <li><a href="./lib/mcollective/rpc/agent_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/agent.rb">lib/mcollective/rpc/agent.rb</a></li>
+
+ <li><a href="./lib/mcollective/rpc/request_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/request.rb">lib/mcollective/rpc/request.rb</a></li>
+
+ <li><a href="./lib/mcollective/rpc/audit_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/audit.rb">lib/mcollective/rpc/audit.rb</a></li>
+
+ <li><a href="./lib/mcollective/rpc/stats_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/stats.rb">lib/mcollective/rpc/stats.rb</a></li>
+
+ <li><a href="./lib/mcollective/rpc/result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/result.rb">lib/mcollective/rpc/result.rb</a></li>
+
+ <li><a href="./lib/mcollective/rpc/helpers_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/helpers.rb">lib/mcollective/rpc/helpers.rb</a></li>
+
+ <li><a href="./lib/mcollective/rpc/client_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/client.rb">lib/mcollective/rpc/client.rb</a></li>
+
+ <li><a href="./lib/mcollective/facts_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/facts.rb">lib/mcollective/facts.rb</a></li>
+
+ <li><a href="./lib/mcollective/data_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/data.rb">lib/mcollective/data.rb</a></li>
+
+ <li><a href="./lib/mcollective/client_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/client.rb">lib/mcollective/client.rb</a></li>
+
+ <li><a href="./lib/mcollective/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.rb</a></li>
+
+ <li><a href="./lib/mcollective/generators_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/generators.rb">lib/mcollective/generators.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Agent.html">MCollective::Agent</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Cache.html">MCollective::Cache</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Connector.html">MCollective::Connector</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/DDL.html">MCollective::DDL</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Data.html">MCollective::Data</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Facts.html">MCollective::Facts</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Generators.html">MCollective::Generators</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Logger.html">MCollective::Logger</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Matcher.html">MCollective::Matcher</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/PluginManager.html">MCollective::PluginManager</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/RPC.html">MCollective::RPC</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Registration.html">MCollective::Registration</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Security.html">MCollective::Security</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Translatable.html">MCollective::Translatable</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Util.html">MCollective::Util</a></li>
+
+ <li><span class="type">MODULE</span> <a href="MCollective/Validator.html">MCollective::Validator</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/Agents.html">MCollective::Agents</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/Aggregate.html">MCollective::Aggregate</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/Application.html">MCollective::Application</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/Applications.html">MCollective::Applications</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/Client.html">MCollective::Client</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/CodedError.html">MCollective::CodedError</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/Config.html">MCollective::Config</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/Discovery.html">MCollective::Discovery</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/Log.html">MCollective::Log</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/Message.html">MCollective::Message</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/Optionparser.html">MCollective::Optionparser</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/RPCError.html">MCollective::RPCError</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/Runner.html">MCollective::Runner</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/SSL.html">MCollective::SSL</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/Shell.html">MCollective::Shell</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
+
+ <li><span class="type">CLASS</span> <a href="MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000000">::version</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="module">MCollective</h1>
+
+ <div id="description">
+ <h2>The Marionette Collective</h2>
+<p>
+Framework to build and run Systems Administration agents running on a
+publish/subscribe middleware system. The system allows you to treat your
+network as the only true source of the state of your platform via discovery
+agents and allow you to run agents matching discovery criteria.
+</p>
+<p>
+For an overview of the idea behind this and what it enables please see:
+</p>
+<pre>
+ http://www.devco.net/archives/2009/10/18/middleware_for_systems_administration.php
+</pre>
+
+ </div>
+
+ <!-- Constants -->
+
+ <div id="constants-list" class="section">
+ <h3 class="section-header">Constants</h3>
+ <dl>
+
+ <dt><a name="VERSION">VERSION</a></dt>
+
+ <dd class="description missing-docs">(Not documented)</dd>
+
+
+ </dl>
+ </div>
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="version-method" class="method-detail ">
+ <a name="M000000"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">version</span><span
+ class="method-args">()</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="version-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective.rb, line 65</span>
+65: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">version</span>
+66: <span class="ruby-constant">VERSION</span>
+67: <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>
+
--- /dev/null
+<?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>Module: MCollective::Agent</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="module">
+
+ <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/agent_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/agent.rb">lib/mcollective/agent.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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="module">MCollective::Agent</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::Agents</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/agents_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/agents.rb">lib/mcollective/agents.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="#M000112">::agentlist</a></li>
+
+ <li><a href="#M000101">::new</a></li>
+
+ <li><a href="#M000106">#activate_agent?</a></li>
+
+ <li><a href="#M000105">#class_for_agent</a></li>
+
+ <li><a href="#M000102">#clear!</a></li>
+
+ <li><a href="#M000109">#dispatch</a></li>
+
+ <li><a href="#M000107">#findagentfile</a></li>
+
+ <li><a href="#M000108">#include?</a></li>
+
+ <li><a href="#M000104">#loadagent</a></li>
+
+ <li><a href="#M000103">#loadagents</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::Agents</h1>
+
+ <div id="description">
+ <p>
+A collection of agents, loads them, reloads them and dispatches messages to
+them. It uses the <a href="PluginManager.html">PluginManager</a> to store,
+load and manage instances of plugins.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="agentlist-method" class="method-detail ">
+ <a name="M000112"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">agentlist</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Get a list of agents that we have
+</p>
+
+
+
+ <div class="method-source-code"
+ id="agentlist-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 145</span>
+145: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">agentlist</span>
+146: <span class="ruby-ivar">@@agents</span>.<span class="ruby-identifier">keys</span>
+147: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="new-method" class="method-detail ">
+ <a name="M000101"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(agents = {})</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/agents.rb, line 5</span>
+ 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">agents</span> = {})
+ 6: <span class="ruby-ivar">@config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
+ 7: <span class="ruby-identifier">raise</span> (<span class="ruby-value str">"Configuration has not been loaded, can't load agents"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">configured</span>
+ 8:
+ 9: <span class="ruby-ivar">@@agents</span> = <span class="ruby-identifier">agents</span>
+10:
+11: <span class="ruby-identifier">loadagents</span>
+12: <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="activate-agent--method" class="method-detail ">
+ <a name="M000106"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">activate_agent?</span><span
+ class="method-args">(agent)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Checks if a plugin should be activated by calling activate? on it if it
+responds to that method else always activate it
+</p>
+
+
+
+ <div class="method-source-code"
+ id="activate-agent--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 85</span>
+85: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">activate_agent?</span>(<span class="ruby-identifier">agent</span>)
+86: <span class="ruby-identifier">klass</span> = <span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-value str">"MCollective"</span>).<span class="ruby-identifier">const_get</span>(<span class="ruby-value str">"Agent"</span>).<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">agent</span>.<span class="ruby-identifier">capitalize</span>)
+87:
+88: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"activate?"</span>)
+89: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">activate?</span>
+90: <span class="ruby-keyword kw">else</span>
+91: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"#{klass} does not have an activate? method, activating as default"</span>)
+92: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+93: <span class="ruby-keyword kw">end</span>
+94: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+95: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Agent activation check for #{agent} failed: #{e.class}: #{e}"</span>)
+96: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+97: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="class-for-agent-method" class="method-detail ">
+ <a name="M000105"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">class_for_agent</span><span
+ class="method-args">(agent)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Builds a class name string given a <a href="Agent.html">Agent</a> name
+</p>
+
+
+
+ <div class="method-source-code"
+ id="class-for-agent-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 78</span>
+78: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">class_for_agent</span>(<span class="ruby-identifier">agent</span>)
+79: <span class="ruby-node">"MCollective::Agent::#{agent.capitalize}"</span>
+80: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="clear--method" class="method-detail ">
+ <a name="M000102"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">clear!</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Deletes all agents
+</p>
+
+
+
+ <div class="method-source-code"
+ id="clear--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 15</span>
+15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">clear!</span>
+16: <span class="ruby-ivar">@@agents</span>.<span class="ruby-identifier">each_key</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">agent</span><span class="ruby-operator">|</span>
+17: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">delete</span> <span class="ruby-node">"#{agent}_agent"</span>
+18: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">unsubscribe</span>(<span class="ruby-constant">Util</span>.<span class="ruby-identifier">make_subscriptions</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:broadcast</span>))
+19: <span class="ruby-keyword kw">end</span>
+20:
+21: <span class="ruby-ivar">@@agents</span> = {}
+22: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="dispatch-method" class="method-detail ">
+ <a name="M000109"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">dispatch</span><span
+ class="method-args">(request, connection)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Dispatches a message to an agent, accepts a block that will get run if
+there are any replies to process from the agent
+</p>
+
+
+
+ <div class="method-source-code"
+ id="dispatch-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 118</span>
+118: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dispatch</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">connection</span>)
+119: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Dispatching a message to agent #{request.agent}"</span>)
+120:
+121: <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span>
+122: <span class="ruby-keyword kw">begin</span>
+123: <span class="ruby-identifier">agent</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-node">"#{request.agent}_agent"</span>]
+124:
+125: <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-identifier">timeout</span>(<span class="ruby-identifier">agent</span>.<span class="ruby-identifier">timeout</span>) <span class="ruby-keyword kw">do</span>
+126: <span class="ruby-identifier">replies</span> = <span class="ruby-identifier">agent</span>.<span class="ruby-identifier">handlemsg</span>(<span class="ruby-identifier">request</span>.<span class="ruby-identifier">payload</span>, <span class="ruby-identifier">connection</span>)
+127:
+128: <span class="ruby-comment cmt"># Agents can decide if they wish to reply or not,</span>
+129: <span class="ruby-comment cmt"># returning nil will mean nothing goes back to the</span>
+130: <span class="ruby-comment cmt"># requestor</span>
+131: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">replies</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
+132: <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">replies</span>)
+133: <span class="ruby-keyword kw">end</span>
+134: <span class="ruby-keyword kw">end</span>
+135: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+136: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Timeout while handling message for #{request.agent}"</span>)
+137: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+138: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Execution of #{request.agent} failed: #{e}"</span>)
+139: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n\t\t"</span>))
+140: <span class="ruby-keyword kw">end</span>
+141: <span class="ruby-keyword kw">end</span>
+142: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="findagentfile-method" class="method-detail ">
+ <a name="M000107"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">findagentfile</span><span
+ class="method-args">(agentname)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+searches the libdirs for agents
+</p>
+
+
+
+ <div class="method-source-code"
+ id="findagentfile-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 100</span>
+100: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">findagentfile</span>(<span class="ruby-identifier">agentname</span>)
+101: <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">libdir</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">libdir</span><span class="ruby-operator">|</span>
+102: <span class="ruby-identifier">agentfile</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>([<span class="ruby-identifier">libdir</span>, <span class="ruby-value str">"mcollective"</span>, <span class="ruby-value str">"agent"</span>, <span class="ruby-node">"#{agentname}.rb"</span>])
+103: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">agentfile</span>)
+104: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Found #{agentname} at #{agentfile}"</span>)
+105: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">agentfile</span>
+106: <span class="ruby-keyword kw">end</span>
+107: <span class="ruby-keyword kw">end</span>
+108: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+109: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="include--method" class="method-detail ">
+ <a name="M000108"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">include?</span><span
+ class="method-args">(agentname)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Determines if we have an agent with a certain name
+</p>
+
+
+
+ <div class="method-source-code"
+ id="include--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 112</span>
+112: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">agentname</span>)
+113: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-node">"#{agentname}_agent"</span>)
+114: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="loadagent-method" class="method-detail ">
+ <a name="M000104"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">loadagent</span><span
+ class="method-args">(agentname)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Loads a specified agent from disk if available
+</p>
+
+
+
+ <div class="method-source-code"
+ id="loadagent-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 42</span>
+42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">loadagent</span>(<span class="ruby-identifier">agentname</span>)
+43: <span class="ruby-identifier">agentfile</span> = <span class="ruby-identifier">findagentfile</span>(<span class="ruby-identifier">agentname</span>)
+44: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">agentfile</span>
+45: <span class="ruby-identifier">classname</span> = <span class="ruby-identifier">class_for_agent</span>(<span class="ruby-identifier">agentname</span>)
+46:
+47: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-node">"#{agentname}_agent"</span>)
+48:
+49: <span class="ruby-keyword kw">begin</span>
+50: <span class="ruby-identifier">single_instance</span> = [<span class="ruby-value str">"registration"</span>, <span class="ruby-value str">"discovery"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">agentname</span>)
+51:
+52: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-identifier">classname</span>)
+53:
+54: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">activate_agent?</span>(<span class="ruby-identifier">agentname</span>)
+55: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{agentname}_agent"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">classname</span>, <span class="ruby-identifier">:single_instance</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">single_instance</span>}
+56:
+57: <span class="ruby-comment cmt"># Attempt to instantiate the agent once so any validation and hooks get run</span>
+58: <span class="ruby-comment cmt"># this does a basic sanity check on the agent as a whole, if this fails it</span>
+59: <span class="ruby-comment cmt"># will be removed from the plugin list</span>
+60: <span class="ruby-constant">PluginManager</span>[<span class="ruby-node">"#{agentname}_agent"</span>]
+61:
+62: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-constant">Util</span>.<span class="ruby-identifier">make_subscriptions</span>(<span class="ruby-identifier">agentname</span>, <span class="ruby-identifier">:broadcast</span>)) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@@agents</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">agentname</span>)
+63:
+64: <span class="ruby-ivar">@@agents</span>[<span class="ruby-identifier">agentname</span>] = {<span class="ruby-identifier">:file</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">agentfile</span>}
+65: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+66: <span class="ruby-keyword kw">else</span>
+67: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Not activating agent #{agentname} due to agent policy in activate? method"</span>)
+68: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+69: <span class="ruby-keyword kw">end</span>
+70: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+71: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Loading agent #{agentname} failed: #{e}"</span>)
+72: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-node">"#{agentname}_agent"</span>)
+73: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+74: <span class="ruby-keyword kw">end</span>
+75: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="loadagents-method" class="method-detail ">
+ <a name="M000103"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">loadagents</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Loads all agents from disk
+</p>
+
+
+
+ <div class="method-source-code"
+ id="loadagents-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 25</span>
+25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">loadagents</span>
+26: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Reloading all agents from disk"</span>)
+27:
+28: <span class="ruby-identifier">clear!</span>
+29:
+30: <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">libdir</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">libdir</span><span class="ruby-operator">|</span>
+31: <span class="ruby-identifier">agentdir</span> = <span class="ruby-node">"#{libdir}/mcollective/agent"</span>
+32: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">agentdir</span>)
+33:
+34: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">agentdir</span>).<span class="ruby-identifier">grep</span>(<span class="ruby-regexp re">/\.rb$/</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">agent</span><span class="ruby-operator">|</span>
+35: <span class="ruby-identifier">agentname</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-value str">".rb"</span>)
+36: <span class="ruby-identifier">loadagent</span>(<span class="ruby-identifier">agentname</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-node">"#{agentname}_agent"</span>)
+37: <span class="ruby-keyword kw">end</span>
+38: <span class="ruby-keyword kw">end</span>
+39: <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>
+
--- /dev/null
+<?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::Aggregate</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/aggregate_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate.rb">lib/mcollective/aggregate.rb</a></li>
+
+ <li><a href="../lib/mcollective/aggregate/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/base.rb">lib/mcollective/aggregate/base.rb</a></li>
+
+ <li><a href="../lib/mcollective/aggregate/result/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result/base.rb">lib/mcollective/aggregate/result/base.rb</a></li>
+
+ <li><a href="../lib/mcollective/aggregate/result/collection_result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result/collection_result.rb">lib/mcollective/aggregate/result/collection_result.rb</a></li>
+
+ <li><a href="../lib/mcollective/aggregate/result/numeric_result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result/numeric_result.rb">lib/mcollective/aggregate/result/numeric_result.rb</a></li>
+
+ <li><a href="../lib/mcollective/aggregate/result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result.rb">lib/mcollective/aggregate/result.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 -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">MODULE</span> <a href="Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
+
+ <li><span class="type">CLASS</span> <a href="Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000135">::new</a></li>
+
+ <li><a href="#M000138">#call_functions</a></li>
+
+ <li><a href="#M000137">#contains_output?</a></li>
+
+ <li><a href="#M000136">#create_functions</a></li>
+
+ <li><a href="#M000140">#load_function</a></li>
+
+ <li><a href="#M000139">#summarize</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::Aggregate</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="ddl-attribute-method" class="method-detail">
+ <a name="ddl"></a>
+
+ <a name="ddl="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ddl</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="functions-attribute-method" class="method-detail">
+ <a name="functions"></a>
+
+ <a name="functions="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">functions</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="action-attribute-method" class="method-detail">
+ <a name="action"></a>
+
+ <a name="action="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">action</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="failed-attribute-method" class="method-detail">
+ <a name="failed"></a>
+
+ <a name="failed="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">failed</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="M000135"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(ddl)</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/aggregate.rb, line 8</span>
+ 8: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">ddl</span>)
+ 9: <span class="ruby-ivar">@functions</span> = []
+10: <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">ddl</span>
+11: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">ddl</span>[<span class="ruby-identifier">:action</span>]
+12: <span class="ruby-ivar">@failed</span> = []
+13:
+14: <span class="ruby-identifier">create_functions</span>
+15: <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="call-functions-method" class="method-detail ">
+ <a name="M000138"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">call_functions</span><span
+ class="method-args">(reply)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Call all the appropriate functions with the reply data received from <a
+href="RPC/Client.html">RPC::Client</a>
+</p>
+
+
+
+ <div class="method-source-code"
+ id="call-functions-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 45</span>
+45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call_functions</span>(<span class="ruby-identifier">reply</span>)
+46: <span class="ruby-ivar">@functions</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">function</span><span class="ruby-operator">|</span>
+47: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Calling aggregate function #{function} for result"</span>)
+48: <span class="ruby-keyword kw">begin</span>
+49: <span class="ruby-identifier">function</span>.<span class="ruby-identifier">process_result</span>(<span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:data</span>][<span class="ruby-identifier">function</span>.<span class="ruby-identifier">output_name</span>], <span class="ruby-identifier">reply</span>)
+50: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+51: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Could not process aggregate function for '#{function.output_name}'. #{e.to_s}"</span>)
+52: <span class="ruby-ivar">@failed</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">function</span>.<span class="ruby-identifier">output_name</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:process_result</span>}
+53: <span class="ruby-ivar">@functions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">function</span>)
+54: <span class="ruby-keyword kw">end</span>
+55: <span class="ruby-keyword kw">end</span>
+56: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="contains-output--method" class="method-detail ">
+ <a name="M000137"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">contains_output?</span><span
+ class="method-args">(output)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Check if the function param is defined as an output for the action in the
+ddl
+</p>
+
+
+
+ <div class="method-source-code"
+ id="contains-output--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 40</span>
+40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">contains_output?</span>(<span class="ruby-identifier">output</span>)
+41: <span class="ruby-ivar">@ddl</span>[<span class="ruby-identifier">:output</span>].<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">output</span>)
+42: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="create-functions-method" class="method-detail ">
+ <a name="M000136"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">create_functions</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates instances of the <a href="Aggregate.html">Aggregate</a> functions
+and stores them in the function array. All aggregate call and summarize
+method calls operate on these function as a batch.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="create-functions-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 19</span>
+19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_functions</span>
+20: <span class="ruby-ivar">@ddl</span>[<span class="ruby-identifier">:aggregate</span>].<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">agg</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
+21: <span class="ruby-identifier">output</span> = <span class="ruby-identifier">agg</span>[<span class="ruby-identifier">:args</span>][<span class="ruby-value">0</span>]
+22:
+23: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">contains_output?</span>(<span class="ruby-identifier">output</span>)
+24: <span class="ruby-identifier">arguments</span> = <span class="ruby-identifier">agg</span>[<span class="ruby-identifier">:args</span>][<span class="ruby-value">1</span>]
+25: <span class="ruby-identifier">format</span> = (<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">:format</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arguments</span>) <span class="ruby-operator">||</span> <span class="ruby-keyword kw">nil</span>
+26: <span class="ruby-keyword kw">begin</span>
+27: <span class="ruby-ivar">@functions</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">load_function</span>(<span class="ruby-identifier">agg</span>[<span class="ruby-identifier">:function</span>]).<span class="ruby-identifier">new</span>(<span class="ruby-identifier">output</span>, <span class="ruby-identifier">arguments</span>, <span class="ruby-identifier">format</span>, <span class="ruby-ivar">@action</span>)
+28: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+29: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Cannot create aggregate function '#{output}'. #{e.to_s}"</span>)
+30: <span class="ruby-ivar">@failed</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">output</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:startup</span>}
+31: <span class="ruby-keyword kw">end</span>
+32: <span class="ruby-keyword kw">else</span>
+33: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Cannot create aggregate function '#{output}'. '#{output}' has not been specified as a valid ddl output."</span>)
+34: <span class="ruby-ivar">@failed</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">output</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:create</span>}
+35: <span class="ruby-keyword kw">end</span>
+36: <span class="ruby-keyword kw">end</span>
+37: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="load-function-method" class="method-detail ">
+ <a name="M000140"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_function</span><span
+ class="method-args">(function_name)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Loads function from disk for use
+</p>
+
+
+
+ <div class="method-source-code"
+ id="load-function-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 76</span>
+76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_function</span>(<span class="ruby-identifier">function_name</span>)
+77: <span class="ruby-identifier">function_name</span> = <span class="ruby-identifier">function_name</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">capitalize</span>
+78:
+79: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"MCollective::Aggregate::#{function_name}"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Aggregate</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-identifier">function_name</span>)
+80: <span class="ruby-constant">Aggregate</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">function_name</span>)
+81: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span>
+82: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Aggregate function file '#{function_name.downcase}.rb' cannot be loaded"</span>
+83: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="summarize-method" class="method-detail ">
+ <a name="M000139"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">summarize</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Finalizes the function returning a result object
+</p>
+
+
+
+ <div class="method-source-code"
+ id="summarize-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 59</span>
+59: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">summarize</span>
+60: <span class="ruby-identifier">summary</span> = <span class="ruby-ivar">@functions</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">function</span><span class="ruby-operator">|</span>
+61: <span class="ruby-keyword kw">begin</span>
+62: <span class="ruby-identifier">function</span>.<span class="ruby-identifier">summarize</span>
+63: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+64: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Could not summarize aggregate result for '#{function.output_name}'. #{e.to_s}"</span>)
+65: <span class="ruby-ivar">@failed</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">function</span>.<span class="ruby-identifier">output_name</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:summarize</span>}
+66: <span class="ruby-keyword kw">nil</span>
+67: <span class="ruby-keyword kw">end</span>
+68: <span class="ruby-keyword kw">end</span>
+69:
+70: <span class="ruby-identifier">summary</span>.<span class="ruby-identifier">reject</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">nil?</span>}.<span class="ruby-identifier">sort</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span>,<span class="ruby-identifier">y</span><span class="ruby-operator">|</span>
+71: <span class="ruby-identifier">x</span>.<span class="ruby-identifier">result</span>[<span class="ruby-identifier">:output</span>] <span class="ruby-operator"><=></span> <span class="ruby-identifier">y</span>.<span class="ruby-identifier">result</span>[<span class="ruby-identifier">:output</span>]
+72: <span class="ruby-keyword kw">end</span>
+73: <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>
+
--- /dev/null
+<?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::Aggregate::Base</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/aggregate/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/base.rb">lib/mcollective/aggregate/base.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="#M000249">::new</a></li>
+
+ <li><a href="#M000251">#result_class</a></li>
+
+ <li><a href="#M000250">#summarize</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::Aggregate::Base</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="name-attribute-method" class="method-detail">
+ <a name="name"></a>
+
+ <a name="name="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">name</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="result-attribute-method" class="method-detail">
+ <a name="result"></a>
+
+ <a name="result="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">result</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="output-name-attribute-method" class="method-detail">
+ <a name="output_name"></a>
+
+ <a name="output_name="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">output_name</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="action-attribute-method" class="method-detail">
+ <a name="action"></a>
+
+ <a name="action="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">action</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="aggregate-format-attribute-method" class="method-detail">
+ <a name="aggregate_format"></a>
+
+ <a name="aggregate_format="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">aggregate_format</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="arguments-attribute-method" class="method-detail">
+ <a name="arguments"></a>
+
+ <a name="arguments="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">arguments</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="M000249"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(output_name, arguments, aggregate_format, action)</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/aggregate/base.rb, line 6</span>
+ 6: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">output_name</span>, <span class="ruby-identifier">arguments</span>, <span class="ruby-identifier">aggregate_format</span>, <span class="ruby-identifier">action</span>)
+ 7: <span class="ruby-ivar">@name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>
+ 8: <span class="ruby-ivar">@output_name</span> = <span class="ruby-identifier">output_name</span>
+ 9:
+10: <span class="ruby-comment cmt"># Any additional arguments passed in the ddl after the output field will</span>
+11: <span class="ruby-comment cmt"># be stored in the arguments array which can be used in the function</span>
+12: <span class="ruby-ivar">@arguments</span> = <span class="ruby-identifier">arguments</span>
+13: <span class="ruby-ivar">@aggregate_format</span> = <span class="ruby-identifier">aggregate_format</span>
+14: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
+15: <span class="ruby-ivar">@result</span> = {<span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">:output</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">output_name</span>}
+16:
+17: <span class="ruby-identifier">startup_hook</span>
+18: <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="result-class-method" class="method-detail ">
+ <a name="M000251"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">result_class</span><span
+ class="method-args">(type)</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="result-class-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/aggregate/base.rb, line 35</span>
+35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">result_class</span>(<span class="ruby-identifier">type</span>)
+36: <span class="ruby-constant">Result</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-node">"#{type.to_s.capitalize}Result"</span>)
+37: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="summarize-method" class="method-detail ">
+ <a name="M000250"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">summarize</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Stops execution of the function and returns a specific ResultObject,
+aggregate functions will most likely override this but this is the simplest
+case so we might as well default to that
+</p>
+
+
+
+ <div class="method-source-code"
+ id="summarize-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/aggregate/base.rb, line 29</span>
+29: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">summarize</span>
+30: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Result type is not set while trying to summarize aggregate function results"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:type</span>]
+31:
+32: <span class="ruby-identifier">result_class</span>(<span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:type</span>]).<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@result</span>, <span class="ruby-ivar">@aggregate_format</span>, <span class="ruby-ivar">@action</span>)
+33: <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>
+
--- /dev/null
+<?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>Module: MCollective::Aggregate::Result</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="module">
+
+ <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/aggregate/result/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result/base.rb">lib/mcollective/aggregate/result/base.rb</a></li>
+
+ <li><a href="../../lib/mcollective/aggregate/result/collection_result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result/collection_result.rb">lib/mcollective/aggregate/result/collection_result.rb</a></li>
+
+ <li><a href="../../lib/mcollective/aggregate/result/numeric_result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result/numeric_result.rb">lib/mcollective/aggregate/result/numeric_result.rb</a></li>
+
+ <li><a href="../../lib/mcollective/aggregate/result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result.rb">lib/mcollective/aggregate/result.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
+
+ <li><span class="type">CLASS</span> <a href="Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
+
+ <li><span class="type">CLASS</span> <a href="Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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="module">MCollective::Aggregate::Result</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::Aggregate::Result::Base</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/aggregate/result/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result/base.rb">lib/mcollective/aggregate/result/base.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="#M000252">::new</a></li>
+
+ <li><a href="#M000254">#result_type</a></li>
+
+ <li><a href="#M000253">#to_s</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::Aggregate::Result::Base</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="result-attribute-method" class="method-detail">
+ <a name="result"></a>
+
+ <a name="result="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">result</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="aggregate-format-attribute-method" class="method-detail">
+ <a name="aggregate_format"></a>
+
+ <a name="aggregate_format="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">aggregate_format</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="action-attribute-method" class="method-detail">
+ <a name="action"></a>
+
+ <a name="action="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">action</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="M000252"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(result, aggregate_format, action)</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/aggregate/result/base.rb, line 7</span>
+ 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">aggregate_format</span>, <span class="ruby-identifier">action</span>)
+ 8: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No aggregate_format defined in ddl or aggregate function"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">aggregate_format</span>
+ 9:
+10: <span class="ruby-ivar">@result</span> = <span class="ruby-identifier">result</span>
+11: <span class="ruby-ivar">@aggregate_format</span> = <span class="ruby-identifier">aggregate_format</span>
+12: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
+13: <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="result-type-method" class="method-detail ">
+ <a name="M000254"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">result_type</span><span
+ class="method-args">()</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="result-type-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/base.rb, line 19</span>
+19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">result_type</span>
+20: <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:type</span>]
+21: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="to-s-method" class="method-detail ">
+ <a name="M000253"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">to_s</span><span
+ class="method-args">()</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="to-s-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/base.rb, line 15</span>
+15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
+16: <span class="ruby-identifier">raise</span> <span class="ruby-node">"'to_s' method not implemented for result class '#{self.class}'"</span>
+17: <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>
+
--- /dev/null
+<?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::Aggregate::Result::CollectionResult</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/aggregate/result/collection_result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result/collection_result.rb">lib/mcollective/aggregate/result/collection_result.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">Base</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="#M000255">#to_s</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::Aggregate::Result::CollectionResult</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="to-s-method" class="method-detail ">
+ <a name="M000255"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">to_s</span><span
+ class="method-args">()</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="to-s-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/collection_result.rb, line 5</span>
+ 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
+ 6: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:value</span>].<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-keyword kw">nil</span>)
+ 7:
+ 8: <span class="ruby-identifier">result</span> = <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>
+ 9:
+10: <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:value</span>].<span class="ruby-identifier">sort</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span>,<span class="ruby-identifier">y</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>[<span class="ruby-value">1</span>] <span class="ruby-operator"><=></span> <span class="ruby-identifier">y</span>[<span class="ruby-value">1</span>]}.<span class="ruby-identifier">reverse</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
+11: <span class="ruby-identifier">result</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@aggregate_format</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>], <span class="ruby-identifier">value</span>[<span class="ruby-value">1</span>]]
+12: <span class="ruby-keyword kw">end</span>
+13:
+14: <span class="ruby-identifier">result</span>.<span class="ruby-identifier">string</span>.<span class="ruby-identifier">chomp</span>
+15: <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>
+
--- /dev/null
+<?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::Aggregate::Result::NumericResult</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/aggregate/result/numeric_result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/aggregate/result/numeric_result.rb">lib/mcollective/aggregate/result/numeric_result.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">Base</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="#M000256">#to_s</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::Aggregate::Result::NumericResult</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="to-s-method" class="method-detail ">
+ <a name="M000256"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">to_s</span><span
+ class="method-args">()</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="to-s-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/numeric_result.rb, line 5</span>
+5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
+6: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:value</span>].<span class="ruby-identifier">nil?</span>
+7:
+8: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@aggregate_format</span> <span class="ruby-operator">%</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:value</span>]
+9: <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>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>Class: MCollective::Application</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Application</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/application_rb.html">
- lib/mcollective/application.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000347">[]</a>
- <a href="#M000346">[]=</a>
- <a href="#M000362">application_cli_arguments</a>
- <a href="#M000360">application_description</a>
- <a href="#M000363">application_failure</a>
- <a href="#M000345">application_options</a>
- <a href="#M000359">application_options</a>
- <a href="#M000357">application_parse_options</a>
- <a href="#M000361">application_usage</a>
- <a href="#M000356">clioptions</a>
- <a href="#M000353">configuration</a>
- <a href="#M000348">description</a>
- <a href="#M000366">disconnect</a>
- <a href="#M000350">exclude_argument_sections</a>
- <a href="#M000369">halt</a>
- <a href="#M000368">halt_code</a>
- <a href="#M000364">help</a>
- <a href="#M000352">intialize_application_options</a>
- <a href="#M000367">main</a>
- <a href="#M000351">option</a>
- <a href="#M000354">options</a>
- <a href="#M000370">rpcclient</a>
- <a href="#M000365">run</a>
- <a href="#M000349">usage</a>
- <a href="#M000358">validate_cli_options</a>
- <a href="#M000355">validate_option</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
- <div id="includes">
- <h3 class="section-bar">Included Modules</h3>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- <div id="includes-list">
- <span class="include-name"><a href="RPC.html">RPC</a></span>
- </div>
- </div>
+ <title>Class: MCollective::Application</title>
- <div id="section">
+ <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>
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000347" class="method-detail">
- <a name="M000347"></a>
-
- <div class="method-heading">
- <a href="#M000347" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(option)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-retrieves a specific <a href="Application.html#M000351">option</a>
+</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/application_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/application.rb">lib/mcollective/application.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="#M000003">::[]</a></li>
+
+ <li><a href="#M000002">::[]=</a></li>
+
+ <li><a href="#M000001">::application_options</a></li>
+
+ <li><a href="#M000004">::description</a></li>
+
+ <li><a href="#M000006">::exclude_argument_sections</a></li>
+
+ <li><a href="#M000008">::intialize_application_options</a></li>
+
+ <li><a href="#M000007">::option</a></li>
+
+ <li><a href="#M000005">::usage</a></li>
+
+ <li><a href="#M000018">#application_cli_arguments</a></li>
+
+ <li><a href="#M000016">#application_description</a></li>
+
+ <li><a href="#M000019">#application_failure</a></li>
+
+ <li><a href="#M000015">#application_options</a></li>
+
+ <li><a href="#M000013">#application_parse_options</a></li>
+
+ <li><a href="#M000017">#application_usage</a></li>
+
+ <li><a href="#M000012">#clioptions</a></li>
+
+ <li><a href="#M000009">#configuration</a></li>
+
+ <li><a href="#M000025">#disconnect</a></li>
+
+ <li><a href="#M000029">#halt</a></li>
+
+ <li><a href="#M000027">#halt_code</a></li>
+
+ <li><a href="#M000022">#help</a></li>
+
+ <li><a href="#M000026">#main</a></li>
+
+ <li><a href="#M000010">#options</a></li>
+
+ <li><a href="#M000030">#rpcclient</a></li>
+
+ <li><a href="#M000023">#run</a></li>
+
+ <li><a href="#M000014">#validate_cli_options</a></li>
+
+ <li><a href="#M000011">#validate_option</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ <div id="includes-section" class="section">
+ <h3 class="section-header">Included Modules</h3>
+ <ul class="link-list">
+
+
+ <li><a class="include" href="Validator.html">MCollective::Validator</a></li>
+
+
+ </ul>
+ </div>
+
+ </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::Application</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000003"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(option)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+retrieves a specific option
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000347-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000347-source">
+
+
+
+ <div class="method-source-code"
+ id="--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 20</span>
20: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">option</span>)
21: <span class="ruby-identifier">intialize_application_options</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@application_options</span>
22: <span class="ruby-ivar">@application_options</span>[<span class="ruby-identifier">option</span>]
-23: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000346" class="method-detail">
- <a name="M000346"></a>
-
- <div class="method-heading">
- <a href="#M000346" class="method-signature">
- <span class="method-name">[]=</span><span class="method-args">(option, value)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-set an <a href="Application.html#M000351">option</a> in the <a
-href="Application.html#M000354">options</a> hash
+23: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000002"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]=</span><span
+ class="method-args">(option, value)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+set an option in the options hash
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000346-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000346-source">
+
+
+
+ <div class="method-source-code"
+ id="--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 14</span>
14: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">option</span>, <span class="ruby-identifier">value</span>)
15: <span class="ruby-identifier">intialize_application_options</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@application_options</span>
16: <span class="ruby-ivar">@application_options</span>[<span class="ruby-identifier">option</span>] = <span class="ruby-identifier">value</span>
-17: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000345" class="method-detail">
- <a name="M000345"></a>
-
- <div class="method-heading">
- <a href="#M000345" class="method-signature">
- <span class="method-name">application_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Intialize a blank set of <a href="Application.html#M000354">options</a> if
-its the first time used else returns active <a
-href="Application.html#M000354">options</a>
+17: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="application-options-method" class="method-detail ">
+ <a name="M000001"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Intialize a blank set of options if its the first time used else returns
+active options
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000345-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000345-source">
+
+
+
+ <div class="method-source-code"
+ id="application-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 8</span>
8: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_options</span>
9: <span class="ruby-identifier">intialize_application_options</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@application_options</span>
10: <span class="ruby-ivar">@application_options</span>
-11: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000348" class="method-detail">
- <a name="M000348"></a>
-
- <div class="method-heading">
- <a href="#M000348" class="method-signature">
- <span class="method-name">description</span><span class="method-args">(descr)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets the application <a href="Application.html#M000348">description</a>,
-there can be only one <a href="Application.html#M000348">description</a>
-per application so multiple calls will just change the <a
-href="Application.html#M000348">description</a>
+11: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="description-method" class="method-detail ">
+ <a name="M000004"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">description</span><span
+ class="method-args">(descr)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sets the application description, there can be only one description per
+application so multiple calls will just change the description
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000348-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000348-source">
+
+
+
+ <div class="method-source-code"
+ id="description-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 28</span>
28: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">description</span>(<span class="ruby-identifier">descr</span>)
29: <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">:description</span>] = <span class="ruby-identifier">descr</span>
-30: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000350" class="method-detail">
- <a name="M000350"></a>
-
- <div class="method-heading">
- <a href="#M000350" class="method-signature">
- <span class="method-name">exclude_argument_sections</span><span class="method-args">(*sections)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000350-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000350-source">
+30: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="exclude-argument-sections-method" class="method-detail ">
+ <a name="M000006"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">exclude_argument_sections</span><span
+ class="method-args">(*sections)</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="exclude-argument-sections-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 38</span>
38: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">exclude_argument_sections</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">sections</span>)
44:
45: <span class="ruby-identifier">intialize_application_options</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@application_options</span>
46: <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">:exclude_arg_sections</span>] = <span class="ruby-identifier">sections</span>
-47: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000352" class="method-detail">
- <a name="M000352"></a>
-
- <div class="method-heading">
- <a href="#M000352" class="method-signature">
- <span class="method-name">intialize_application_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates an empty set of <a href="Application.html#M000354">options</a>
+47: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="intialize-application-options-method" class="method-detail ">
+ <a name="M000008"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">intialize_application_options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates an empty set of options
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000352-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000352-source">
+
+
+
+ <div class="method-source-code"
+ id="intialize-application-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 79</span>
79: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">intialize_application_options</span>
81: <span class="ruby-identifier">:usage</span> =<span class="ruby-operator">></span> [],
82: <span class="ruby-identifier">:cli_arguments</span> =<span class="ruby-operator">></span> [],
83: <span class="ruby-identifier">:exclude_arg_sections</span> =<span class="ruby-operator">></span> []}
-84: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000351" class="method-detail">
- <a name="M000351"></a>
-
- <div class="method-heading">
- <a href="#M000351" class="method-signature">
- <span class="method-name">option</span><span class="method-args">(name, arguments)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Wrapper to create command line <a
-href="Application.html#M000354">options</a>
+84: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="option-method" class="method-detail ">
+ <a name="M000007"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">option</span><span
+ class="method-args">(name, arguments)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Wrapper to create command line options
</p>
<pre>
- name: varaible name that will be used to access the option value
:arguments => ["--foo ARG"]
</pre>
<p>
-after this the value supplied will be in <a
-href="Application.html#M000353">configuration</a>[:foo]
+after this the value supplied will be in configuration[:foo]
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000351-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000351-source">
+
+
+
+ <div class="method-source-code"
+ id="option-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 65</span>
65: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">option</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">arguments</span>)
73: <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">each_pair</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">opt</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">v</span>}
74:
75: <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">:cli_arguments</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">opt</span>
-76: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000349" class="method-detail">
- <a name="M000349"></a>
-
- <div class="method-heading">
- <a href="#M000349" class="method-signature">
- <span class="method-name">usage</span><span class="method-args">(usage)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Supplies <a href="Application.html#M000349">usage</a> information, calling
-multiple times will create multiple <a
-href="Application.html#M000349">usage</a> lines in —<a
-href="Application.html#M000364">help</a> output
+76: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="usage-method" class="method-detail ">
+ <a name="M000005"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">usage</span><span
+ class="method-args">(usage)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Supplies usage information, calling multiple times will create multiple
+usage lines in —help output
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000349-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000349-source">
+
+
+
+ <div class="method-source-code"
+ id="usage-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 34</span>
34: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">usage</span>(<span class="ruby-identifier">usage</span>)
35: <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">:usage</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">usage</span>
-36: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000362" class="method-detail">
- <a name="M000362"></a>
-
- <div class="method-heading">
- <a href="#M000362" class="method-signature">
- <span class="method-name">application_cli_arguments</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+36: <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="application-cli-arguments-method" class="method-detail ">
+ <a name="M000018"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_cli_arguments</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns an array of all the arguments built using calls to optin
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000362-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000362-source">
+
+
+
+ <div class="method-source-code"
+ id="application-cli-arguments-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 247</span>
247: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_cli_arguments</span>
248: <span class="ruby-identifier">application_options</span>[<span class="ruby-identifier">:cli_arguments</span>]
-249: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000360" class="method-detail">
- <a name="M000360"></a>
-
- <div class="method-heading">
- <a href="#M000360" class="method-signature">
- <span class="method-name">application_description</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Retrieve the current application <a
-href="Application.html#M000348">description</a>
+249: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="application-description-method" class="method-detail ">
+ <a name="M000016"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_description</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Retrieve the current application description
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000360-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000360-source">
+
+
+
+ <div class="method-source-code"
+ id="application-description-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 234</span>
234: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_description</span>
235: <span class="ruby-identifier">application_options</span>[<span class="ruby-identifier">:description</span>]
-236: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000363" class="method-detail">
- <a name="M000363"></a>
-
- <div class="method-heading">
- <a href="#M000363" class="method-signature">
- <span class="method-name">application_failure</span><span class="method-args">(e, err_dest=STDERR)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Handles failure, if we‘re far enough in the initialization phase it
+236: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="application-failure-method" class="method-detail ">
+ <a name="M000019"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_failure</span><span
+ class="method-args">(e, err_dest=STDERR)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Handles failure, if we’re far enough in the initialization phase it
will log backtraces if its in verbose mode only
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000363-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000363-source">
+
+
+
+ <div class="method-source-code"
+ id="application-failure-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 253</span>
253: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_failure</span>(<span class="ruby-identifier">e</span>, <span class="ruby-identifier">err_dest</span>=<span class="ruby-constant">STDERR</span>)
283: <span class="ruby-identifier">disconnect</span>
284:
285: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
-286: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000359" class="method-detail">
- <a name="M000359"></a>
-
- <div class="method-heading">
- <a href="#M000359" class="method-signature">
- <span class="method-name">application_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Retrieves the full hash of application <a
-href="Application.html#M000354">options</a>
+286: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="application-options-method" class="method-detail ">
+ <a name="M000015"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Retrieves the full hash of application options
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000359-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000359-source">
+
+
+
+ <div class="method-source-code"
+ id="application-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 229</span>
229: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_options</span>
230: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">application_options</span>
-231: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000357" class="method-detail">
- <a name="M000357"></a>
-
- <div class="method-heading">
- <a href="#M000357" class="method-signature">
- <span class="method-name">application_parse_options</span><span class="method-args">(help=false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Builds an ObjectParser config, parse the CLI <a
-href="Application.html#M000354">options</a> and validates based on the <a
-href="Application.html#M000351">option</a> config
+231: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="application-parse-options-method" class="method-detail ">
+ <a name="M000013"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_parse_options</span><span
+ class="method-args">(help=false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Builds an ObjectParser config, parse the CLI options and validates based on
+the option config
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000357-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000357-source">
+
+
+
+ <div class="method-source-code"
+ id="application-parse-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 135</span>
135: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_parse_options</span>(<span class="ruby-identifier">help</span>=<span class="ruby-keyword kw">false</span>)
202: <span class="ruby-keyword kw">end</span>
203: <span class="ruby-keyword kw">end</span>
204: <span class="ruby-keyword kw">end</span>
-205: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000361" class="method-detail">
- <a name="M000361"></a>
-
- <div class="method-heading">
- <a href="#M000361" class="method-signature">
- <span class="method-name">application_usage</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Return the current <a href="Application.html#M000349">usage</a> text false
-if nothing is set
+205: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="application-usage-method" class="method-detail ">
+ <a name="M000017"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">application_usage</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Return the current usage text false if nothing is set
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000361-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000361-source">
+
+
+
+ <div class="method-source-code"
+ id="application-usage-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 239</span>
239: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">application_usage</span>
240: <span class="ruby-identifier">usage</span> = <span class="ruby-identifier">application_options</span>[<span class="ruby-identifier">:usage</span>]
241:
242: <span class="ruby-identifier">usage</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">false</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">usage</span>
-243: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000356" class="method-detail">
- <a name="M000356"></a>
-
- <div class="method-heading">
- <a href="#M000356" class="method-signature">
- <span class="method-name">clioptions</span><span class="method-args">(help) {|parser, options| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates a standard <a href="Application.html#M000354">options</a> hash,
-pass in a block to add extra headings etc see <a
-href="Optionparser.html">Optionparser</a>
+243: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="clioptions-method" class="method-detail ">
+ <a name="M000012"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">clioptions</span><span
+ class="method-args">(help)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates a standard options hash, pass in a block to add extra headings etc
+see <a href="Optionparser.html">Optionparser</a>
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000356-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000356-source">
+
+
+
+ <div class="method-source-code"
+ id="clioptions-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 111</span>
111: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">clioptions</span>(<span class="ruby-identifier">help</span>)
128: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">options</span>
129: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
130: <span class="ruby-identifier">application_failure</span>(<span class="ruby-identifier">e</span>)
-131: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000353" class="method-detail">
- <a name="M000353"></a>
-
- <div class="method-heading">
- <a href="#M000353" class="method-signature">
- <span class="method-name">configuration</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-The application <a href="Application.html#M000353">configuration</a> built
-from CLI arguments
+131: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="configuration-method" class="method-detail ">
+ <a name="M000009"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">configuration</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+The application configuration built from CLI arguments
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000353-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000353-source">
+
+
+
+ <div class="method-source-code"
+ id="configuration-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 88</span>
88: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configuration</span>
89: <span class="ruby-ivar">@application_configuration</span> <span class="ruby-operator">||=</span> {}
90: <span class="ruby-ivar">@application_configuration</span>
-91: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000366" class="method-detail">
- <a name="M000366"></a>
-
- <div class="method-heading">
- <a href="#M000366" class="method-signature">
- <span class="method-name">disconnect</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000366-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000366-source">
+91: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="disconnect-method" class="method-detail ">
+ <a name="M000025"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">disconnect</span><span
+ class="method-args">()</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="disconnect-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 310</span>
310: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">disconnect</span>
311: <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"connector_plugin"</span>].<span class="ruby-identifier">disconnect</span>
312: <span class="ruby-keyword kw">rescue</span>
-313: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000369" class="method-detail">
- <a name="M000369"></a>
-
- <div class="method-heading">
- <a href="#M000369" class="method-signature">
- <span class="method-name">halt</span><span class="method-args">(stats)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+313: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="halt-method" class="method-detail ">
+ <a name="M000029"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">halt</span><span
+ class="method-args">(stats)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
A helper that creates a consistent exit code for applications by looking at
an instance of <a href="RPC/Stats.html">MCollective::RPC::Stats</a>
</p>
<p>
Exit with 0 if nodes were discovered and all passed Exit with 0 if no
-discovery were done and > 0 responses were received, all ok Exit with 1
-if no nodes were discovered Exit with 2 if nodes were discovered but some
-<a href="RPC.html">RPC</a> requests failed Exit with 3 if nodes were
+discovery were done and > 0 responses were received, all ok Exit with 1 if
+no nodes were discovered Exit with 2 if nodes were discovered but some <a
+href="RPC.html">RPC</a> requests failed Exit with 3 if nodes were
discovered, but no responses received Exit with 4 if no discovery were done
and no responses were received
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000369-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000369-source">
+
+
+
+ <div class="method-source-code"
+ id="halt-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 345</span>
345: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">halt</span>(<span class="ruby-identifier">stats</span>)
346: <span class="ruby-identifier">exit</span>(<span class="ruby-identifier">halt_code</span>(<span class="ruby-identifier">stats</span>))
-347: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000368" class="method-detail">
- <a name="M000368"></a>
-
- <div class="method-heading">
- <a href="#M000368" class="method-signature">
- <span class="method-name">halt_code</span><span class="method-args">(stats)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000368-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000368-source">
+347: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="halt-code-method" class="method-detail ">
+ <a name="M000027"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">halt_code</span><span
+ class="method-args">(stats)</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="halt-code-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 322</span>
322: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">halt_code</span>(<span class="ruby-identifier">stats</span>)
331: <span class="ruby-keyword kw">return</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">request_stats</span>[<span class="ruby-identifier">:discovered</span>] <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
332: <span class="ruby-keyword kw">return</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">request_stats</span>[<span class="ruby-identifier">:discoverytime</span>] <span class="ruby-operator">==</span> <span class="ruby-value">0</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">request_stats</span>[<span class="ruby-identifier">:discovered</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">request_stats</span>[<span class="ruby-identifier">:okcount</span>]
333: <span class="ruby-keyword kw">return</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">request_stats</span>[<span class="ruby-identifier">:discovered</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">request_stats</span>[<span class="ruby-identifier">:okcount</span>]
-334: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000364" class="method-detail">
- <a name="M000364"></a>
-
- <div class="method-heading">
- <a href="#M000364" class="method-signature">
- <span class="method-name">help</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000364-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000364-source">
+334: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="help-method" class="method-detail ">
+ <a name="M000022"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">help</span><span
+ class="method-args">()</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="help-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 288</span>
288: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">help</span>
289: <span class="ruby-identifier">application_parse_options</span>(<span class="ruby-keyword kw">true</span>)
-290: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000367" class="method-detail">
- <a name="M000367"></a>
-
- <div class="method-heading">
- <a href="#M000367" class="method-signature">
- <span class="method-name">main</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+290: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="main-method" class="method-detail ">
+ <a name="M000026"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">main</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Fake abstract class that logs if the user tries to use an application
-without supplying a <a href="Application.html#M000367">main</a> override
-method.
+without supplying a main override method.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000367-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000367-source">
+
+
+
+ <div class="method-source-code"
+ id="main-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 317</span>
317: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">main</span>
318: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-value str">"Applications need to supply a 'main' method"</span>
319: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
-320: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000354" class="method-detail">
- <a name="M000354"></a>
-
- <div class="method-heading">
- <a href="#M000354" class="method-signature">
- <span class="method-name">options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-The active <a href="Application.html#M000354">options</a> hash used for
-MC::Client and other <a href="Application.html#M000353">configuration</a>
+320: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="options-method" class="method-detail ">
+ <a name="M000010"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+The active options hash used for MC::Client and other configuration
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000354-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000354-source">
+
+
+
+ <div class="method-source-code"
+ id="options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 94</span>
94: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">options</span>
95: <span class="ruby-ivar">@options</span>
-96: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000370" class="method-detail">
- <a name="M000370"></a>
-
- <div class="method-heading">
- <a href="#M000370" class="method-signature">
- <span class="method-name">rpcclient</span><span class="method-args">(agent, flags = {})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Wrapper around <a href="RPC.html#M000037">MC::RPC#rpcclient</a> that
-forcably supplies our <a href="Application.html#M000354">options</a> hash
-if someone forgets to pass in <a
-href="Application.html#M000354">options</a> in an application the filters
-and other cli <a href="Application.html#M000354">options</a> wouldnt take
-effect which could have a disasterous outcome
+96: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rpcclient-method" class="method-detail ">
+ <a name="M000030"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rpcclient</span><span
+ class="method-args">(agent, flags = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Wrapper around MC::RPC#rpcclient that forcably supplies our options hash if
+someone forgets to pass in options in an application the filters and other
+cli options wouldnt take effect which could have a disasterous outcome
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000370-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000370-source">
+
+
+
+ <div class="method-source-code"
+ id="rpcclient-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 352</span>
352: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rpcclient</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">flags</span> = {})
354: <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:exit_on_failure</span>] = <span class="ruby-keyword kw">false</span>
355:
356: <span class="ruby-keyword kw">super</span>
-357: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000365" class="method-detail">
- <a name="M000365"></a>
-
- <div class="method-heading">
- <a href="#M000365" class="method-signature">
- <span class="method-name">run</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-The <a href="Application.html#M000367">main</a> logic loop, builds up the
-<a href="Application.html#M000354">options</a>, validate <a
-href="Application.html#M000353">configuration</a> and calls the <a
-href="Application.html#M000367">main</a> as supplied by the user.
-Disconnects when done and pass any exception onto the <a
-href="Application.html#M000363">application_failure</a> helper
+357: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="run-method" class="method-detail ">
+ <a name="M000023"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">run</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+The main logic loop, builds up the options, validate configuration and
+calls the main as supplied by the user. Disconnects when done and pass any
+exception onto the <a
+href="Application.html#M000019">application_failure</a> helper
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000365-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000365-source">
+
+
+
+ <div class="method-source-code"
+ id="run-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 295</span>
295: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>
305:
306: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
307: <span class="ruby-identifier">application_failure</span>(<span class="ruby-identifier">e</span>)
-308: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000358" class="method-detail">
- <a name="M000358"></a>
-
- <div class="method-heading">
- <a href="#M000358" class="method-signature">
- <span class="method-name">validate_cli_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000358-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000358-source">
+308: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-cli-options-method" class="method-detail ">
+ <a name="M000014"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate_cli_options</span><span
+ class="method-args">()</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="validate-cli-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 207</span>
207: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_cli_options</span>
223: <span class="ruby-keyword kw">end</span>
224:
225:
-226: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000355" class="method-detail">
- <a name="M000355"></a>
-
- <div class="method-heading">
- <a href="#M000355" class="method-signature">
- <span class="method-name">validate_option</span><span class="method-args">(blk, name, value)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Calls the supplied block in an <a
-href="Application.html#M000351">option</a> for validation, an error raised
-will log to STDERR and exit the application
+226: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-option-method" class="method-detail ">
+ <a name="M000011"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate_option</span><span
+ class="method-args">(blk, name, value)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Calls the supplied block in an option for validation, an error raised will
+log to STDERR and exit the application
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000355-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000355-source">
+
+
+
+ <div class="method-source-code"
+ id="validate-option-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/application.rb, line 100</span>
100: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_option</span>(<span class="ruby-identifier">blk</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>)
104: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Validation of #{name} failed: #{validation_result}"</span>
105: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
106: <span class="ruby-keyword kw">end</span>
-107: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+107: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </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>
-</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>
\ No newline at end of file
+</html>
+
--- /dev/null
+<?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::Applications</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/applications_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/applications.rb">lib/mcollective/applications.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="#M000095">::[]</a></li>
+
+ <li><a href="#M000099">::filter_extra_options</a></li>
+
+ <li><a href="#M000098">::list</a></li>
+
+ <li><a href="#M000097">::load_application</a></li>
+
+ <li><a href="#M000100">::load_config</a></li>
+
+ <li><a href="#M000096">::run</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::Applications</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000095"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(appname)</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="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/applications.rb, line 3</span>
+3: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">appname</span>)
+4: <span class="ruby-identifier">load_application</span>(<span class="ruby-identifier">appname</span>)
+5: <span class="ruby-constant">PluginManager</span>[<span class="ruby-node">"#{appname}_application"</span>]
+6: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="filter-extra-options-method" class="method-detail ">
+ <a name="M000099"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">filter_extra_options</span><span
+ class="method-args">(opts)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Filters a string of opts out using Shellwords keeping only things related
+to —config and -c
+</p>
+
+
+
+ <div class="method-source-code"
+ id="filter-extra-options-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/applications.rb, line 49</span>
+49: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">filter_extra_options</span>(<span class="ruby-identifier">opts</span>)
+50: <span class="ruby-identifier">res</span> = <span class="ruby-value str">""</span>
+51: <span class="ruby-identifier">words</span> = <span class="ruby-constant">Shellwords</span>.<span class="ruby-identifier">shellwords</span>(<span class="ruby-identifier">opts</span>)
+52: <span class="ruby-identifier">words</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">word</span>,<span class="ruby-identifier">idx</span><span class="ruby-operator">|</span>
+53: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">word</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"-c"</span>
+54: <span class="ruby-keyword kw">return</span> <span class="ruby-node">"--config=#{words[idx + 1]}"</span>
+55: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">word</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"--config"</span>
+56: <span class="ruby-keyword kw">return</span> <span class="ruby-node">"--config=#{words[idx + 1]}"</span>
+57: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">word</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/\-c=/</span>
+58: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">word</span>
+59: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">word</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/\-\-config=/</span>
+60: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">word</span>
+61: <span class="ruby-keyword kw">end</span>
+62: <span class="ruby-keyword kw">end</span>
+63:
+64: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span>
+65: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="list-method" class="method-detail ">
+ <a name="M000098"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">list</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns an array of applications found in the lib dirs
+</p>
+
+
+
+ <div class="method-source-code"
+ id="list-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/applications.rb, line 36</span>
+36: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">list</span>
+37: <span class="ruby-identifier">load_config</span>
+38:
+39: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find</span>(<span class="ruby-value str">"application"</span>)
+40: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">SystemExit</span>
+41: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
+42: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+43: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Failed to generate application list: #{e.class}: #{e}"</span>
+44: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
+45: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="load-application-method" class="method-detail ">
+ <a name="M000097"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_application</span><span
+ class="method-args">(appname)</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="load-application-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/applications.rb, line 26</span>
+26: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_application</span>(<span class="ruby-identifier">appname</span>)
+27: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-node">"#{appname}_application"</span>)
+28:
+29: <span class="ruby-identifier">load_config</span>
+30:
+31: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span> <span class="ruby-node">"MCollective::Application::#{appname.capitalize}"</span>
+32: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{appname}_application"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-node">"MCollective::Application::#{appname.capitalize}"</span>}
+33: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="load-config-method" class="method-detail ">
+ <a name="M000100"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_config</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+We need to know the config file in order to know the libdir so that we can
+find applications.
+</p>
+<p>
+The problem is the CLI might be stuffed with options only the app in the
+libdir might understand so we have a chicken and egg situation.
+</p>
+<p>
+We’re parsing and filtering MCOLLECTIVE_EXTRA_OPTS removing all but
+config related options and parsing the options looking just for the config
+file.
+</p>
+<p>
+We’re handling failures gracefully and finally restoring the ARG and
+MCOLLECTIVE_EXTRA_OPTS to the state they were before we started parsing.
+</p>
+<p>
+This is mostly a hack, when we’re redoing how config works this stuff
+should be made less sucky
+</p>
+
+
+
+ <div class="method-source-code"
+ id="load-config-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/applications.rb, line 84</span>
+ 84: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_config</span>
+ 85: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">configured</span>
+ 86:
+ 87: <span class="ruby-identifier">original_argv</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">clone</span>
+ 88: <span class="ruby-identifier">original_extra_opts</span> = <span class="ruby-constant">ENV</span>[<span class="ruby-value str">"MCOLLECTIVE_EXTRA_OPTS"</span>].<span class="ruby-identifier">clone</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
+ 89: <span class="ruby-identifier">configfile</span> = <span class="ruby-keyword kw">nil</span>
+ 90:
+ 91: <span class="ruby-identifier">parser</span> = <span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">new</span>
+ 92: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"--config CONFIG"</span>, <span class="ruby-value str">"-c"</span>, <span class="ruby-value str">"Config file"</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
+ 93: <span class="ruby-identifier">configfile</span> = <span class="ruby-identifier">f</span>
+ 94: <span class="ruby-keyword kw">end</span>
+ 95:
+ 96: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">program_name</span> = <span class="ruby-identifier">$0</span>
+ 97:
+ 98: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"--help"</span>)
+ 99:
+100: <span class="ruby-comment cmt"># avoid option parsers own internal version handling that sux</span>
+101: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-v"</span>, <span class="ruby-value str">"--verbose"</span>)
+102:
+103: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">original_extra_opts</span>
+104: <span class="ruby-keyword kw">begin</span>
+105: <span class="ruby-comment cmt"># optparse will parse the whole ENV in one go and refuse</span>
+106: <span class="ruby-comment cmt"># to play along with the retry trick I do below so in</span>
+107: <span class="ruby-comment cmt"># order to handle unknown options properly I parse out</span>
+108: <span class="ruby-comment cmt"># only -c and --config deleting everything else and</span>
+109: <span class="ruby-comment cmt"># then restore the environment variable later when I</span>
+110: <span class="ruby-comment cmt"># am done with it</span>
+111: <span class="ruby-constant">ENV</span>[<span class="ruby-value str">"MCOLLECTIVE_EXTRA_OPTS"</span>] = <span class="ruby-identifier">filter_extra_options</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-value str">"MCOLLECTIVE_EXTRA_OPTS"</span>].<span class="ruby-identifier">clone</span>)
+112: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">environment</span>(<span class="ruby-value str">"MCOLLECTIVE_EXTRA_OPTS"</span>)
+113: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+114: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Failed to parse MCOLLECTIVE_EXTRA_OPTS: #{e}"</span>)
+115: <span class="ruby-keyword kw">end</span>
+116:
+117: <span class="ruby-constant">ENV</span>[<span class="ruby-value str">"MCOLLECTIVE_EXTRA_OPTS"</span>] = <span class="ruby-identifier">original_extra_opts</span>.<span class="ruby-identifier">clone</span>
+118: <span class="ruby-keyword kw">end</span>
+119:
+120: <span class="ruby-keyword kw">begin</span>
+121: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">parse!</span>
+122: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidOption</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+123: <span class="ruby-keyword kw">retry</span>
+124: <span class="ruby-keyword kw">end</span>
+125:
+126: <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">clear</span>
+127: <span class="ruby-identifier">original_argv</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-constant">ARGV</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">a</span>}
+128:
+129: <span class="ruby-identifier">configfile</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">config_file_for_user</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">configfile</span>
+130:
+131: <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">loadconfig</span>(<span class="ruby-identifier">configfile</span>)
+132: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="run-method" class="method-detail ">
+ <a name="M000096"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">run</span><span
+ class="method-args">(appname)</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="run-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/applications.rb, line 8</span>
+ 8: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">run</span>(<span class="ruby-identifier">appname</span>)
+ 9: <span class="ruby-identifier">load_config</span>
+10:
+11: <span class="ruby-keyword kw">begin</span>
+12: <span class="ruby-identifier">load_application</span>(<span class="ruby-identifier">appname</span>)
+13: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+14: <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">first</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-value str">" <----"</span>)
+15: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Application '#{appname}' failed to load:"</span>
+16: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span>
+17: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-node">" #{e} (#{e.class})"</span>)
+18: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span>
+19: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-value str">" %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n "</span>)]
+20: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
+21: <span class="ruby-keyword kw">end</span>
+22:
+23: <span class="ruby-constant">PluginManager</span>[<span class="ruby-node">"#{appname}_application"</span>].<span class="ruby-identifier">run</span>
+24: <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>
+
--- /dev/null
+<?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>Module: MCollective::Cache</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="module">
+
+ <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/cache_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/cache.rb">lib/mcollective/cache.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000340">::check_cache!</a></li>
+
+ <li><a href="#M000342">::delete!</a></li>
+
+ <li><a href="#M000341">::has_cache?</a></li>
+
+ <li><a href="#M000349">::invalidate!</a></li>
+
+ <li><a href="#M000344">::read</a></li>
+
+ <li><a href="#M000339">::setup</a></li>
+
+ <li><a href="#M000348">::synchronize</a></li>
+
+ <li><a href="#M000345">::ttl</a></li>
+
+ <li><a href="#M000343">::write</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="module">MCollective::Cache</h1>
+
+ <div id="description">
+ <p>
+A class to manage a number of named caches. Each cache can have a unique
+timeout for keys in it and each cache has an independent Mutex protecting
+access to it.
+</p>
+<p>
+This cache is setup early in the process of loading the mcollective
+libraries, before any threads are created etc making it suitable as a cross
+thread cache or just a store for Mutexes you need to use across threads
+like in an <a href="Agent.html">Agent</a> or something.
+</p>
+<pre>
+ # sets up a new cache, noop if it already exist
+ Cache.setup(:ddl, 600)
+ => true
+
+ # writes an item to the :ddl cache, this item will
+ # be valid on the cache for 600 seconds
+ Cache.write(:ddl, :something, "value")
+ => "value"
+
+ # reads from the cache, read failures due to non existing
+ # data or expired data will raise an exception
+ Cache.read(:ddl, :something)
+ => "value"
+
+ # time left till expiry, raises if nothing is found
+ Cache.ttl(:ddl, :something)
+ => 500
+
+ # forcibly evict something from the cache
+ Cache.invalidate!(:ddl, :something)
+ => "value"
+
+ # deletes an entire named cache and its mutexes
+ Cache.delete!(:ddl)
+ => true
+
+ # you can also just use this cache as a global mutex store
+ Cache.setup(:mylock)
+
+ Cache.synchronize(:mylock) do
+ do_something()
+ end
+</pre>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="check-cache--method" class="method-detail ">
+ <a name="M000340"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">check_cache!</span><span
+ class="method-args">(cache_name)</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="check-cache--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 70</span>
+70: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
+71: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC13</span>, <span class="ruby-value str">"Could not find a cache called '%{cache_name}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:cache_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">cache_name</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">has_cache?</span>(<span class="ruby-identifier">cache_name</span>)
+72: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="delete--method" class="method-detail ">
+ <a name="M000342"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">delete!</span><span
+ class="method-args">(cache_name)</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="delete--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 80</span>
+80: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">delete!</span>(<span class="ruby-identifier">cache_name</span>)
+81: <span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
+82:
+83: <span class="ruby-ivar">@locks_mutex</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+84: <span class="ruby-ivar">@cache_locks</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">cache_name</span>)
+85: <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">cache_name</span>)
+86: <span class="ruby-keyword kw">end</span>
+87:
+88: <span class="ruby-keyword kw">true</span>
+89: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-cache--method" class="method-detail ">
+ <a name="M000341"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_cache?</span><span
+ class="method-args">(cache_name)</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="has-cache--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 74</span>
+74: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_cache?</span>(<span class="ruby-identifier">cache_name</span>)
+75: <span class="ruby-ivar">@locks_mutex</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+76: <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">cache_name</span>)
+77: <span class="ruby-keyword kw">end</span>
+78: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="invalidate--method" class="method-detail ">
+ <a name="M000349"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">invalidate!</span><span
+ class="method-args">(cache_name, key)</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="invalidate--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 139</span>
+139: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">invalidate!</span>(<span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">key</span>)
+140: <span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
+141:
+142: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+143: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
+144:
+145: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
+146: <span class="ruby-keyword kw">end</span>
+147: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="read-method" class="method-detail ">
+ <a name="M000344"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">read</span><span
+ class="method-args">(cache_name, key)</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="read-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 103</span>
+103: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">key</span>)
+104: <span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
+105:
+106: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">ttl</span>(<span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">key</span>) <span class="ruby-operator">></span> <span class="ruby-value">0</span>
+107: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC11</span>, <span class="ruby-value str">"Cache expired on '%{cache_name}' key '%{item}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:cache_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">:item</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>)
+108: <span class="ruby-keyword kw">end</span>
+109:
+110: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC12</span>, <span class="ruby-value str">"Cache hit on '%{cache_name}' key '%{item}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:cache_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">:item</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>)
+111:
+112: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+113: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>][<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:value</span>]
+114: <span class="ruby-keyword kw">end</span>
+115: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="setup-method" class="method-detail ">
+ <a name="M000339"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">setup</span><span
+ class="method-args">(cache_name, ttl=300)</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="setup-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 56</span>
+56: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">setup</span>(<span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">ttl</span>=<span class="ruby-value">300</span>)
+57: <span class="ruby-ivar">@locks_mutex</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+58: <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@cache_locks</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">cache_name</span>)
+59:
+60: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>] = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
+61:
+62: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+63: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>] = {<span class="ruby-identifier">:max_age</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Float</span>(<span class="ruby-identifier">ttl</span>)}
+64: <span class="ruby-keyword kw">end</span>
+65: <span class="ruby-keyword kw">end</span>
+66:
+67: <span class="ruby-keyword kw">true</span>
+68: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="synchronize-method" class="method-detail ">
+ <a name="M000348"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">synchronize</span><span
+ class="method-args">(cache_name)</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="synchronize-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 129</span>
+129: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">synchronize</span>(<span class="ruby-identifier">cache_name</span>)
+130: <span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
+131:
+132: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC14</span>, <span class="ruby-value str">"No block supplied to synchronize on cache '%{cache_name}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:cache_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">cache_name</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">block_given?</span>
+133:
+134: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+135: <span class="ruby-keyword kw">yield</span>
+136: <span class="ruby-keyword kw">end</span>
+137: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="ttl-method" class="method-detail ">
+ <a name="M000345"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">ttl</span><span
+ class="method-args">(cache_name, key)</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="ttl-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 117</span>
+117: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ttl</span>(<span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">key</span>)
+118: <span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
+119:
+120: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+121: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
+122: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC15</span>, <span class="ruby-value str">"No item called '%{item}' for cache '%{cache_name}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:cache_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">:item</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>)
+123: <span class="ruby-keyword kw">end</span>
+124:
+125: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>][<span class="ruby-identifier">:max_age</span>] <span class="ruby-operator">-</span> (<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>][<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:cache_create_time</span>])
+126: <span class="ruby-keyword kw">end</span>
+127: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="write-method" class="method-detail ">
+ <a name="M000343"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">write</span><span
+ class="method-args">(cache_name, key, value)</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="write-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 91</span>
+ 91: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>)
+ 92: <span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
+ 93:
+ 94: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+ 95: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>][<span class="ruby-identifier">key</span>] <span class="ruby-operator">||=</span> {}
+ 96: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>][<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:cache_create_time</span>] = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
+ 97: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>][<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:value</span>] = <span class="ruby-identifier">value</span>
+ 98: <span class="ruby-keyword kw">end</span>
+ 99:
+100: <span class="ruby-identifier">value</span>
+101: <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>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>Class: MCollective::Client</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Client</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/client_rb.html">
- lib/mcollective/client.rb
- </a>
- <br />
- </td>
- </tr>
+ <title>Class: MCollective::Client</title>
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
- <div id="bodyContent">
+ <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>
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
+</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/client_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/client.rb">lib/mcollective/client.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="#M000494">::new</a></li>
+
+ <li><a href="#M000495">#collective</a></li>
+
+ <li><a href="#M000498">#createreq</a></li>
+
+ <li><a href="#M000496">#disconnect</a></li>
+
+ <li><a href="#M000502">#discover</a></li>
+
+ <li><a href="#M000512">#discovered_req</a></li>
+
+ <li><a href="#M000513">#display_stats</a></li>
+
+ <li><a href="#M000501">#receive</a></li>
+
+ <li><a href="#M000503">#req</a></li>
+
+ <li><a href="#M000497">#sendreq</a></li>
+
+ <li><a href="#M000509">#start_publisher</a></li>
+
+ <li><a href="#M000510">#start_receiver</a></li>
+
+ <li><a href="#M000499">#subscribe</a></li>
+
+ <li><a href="#M000505">#threaded_req</a></li>
+
+ <li><a href="#M000500">#unsubscribe</a></li>
+
+ <li><a href="#M000504">#unthreaded_req</a></li>
+
+ <li><a href="#M000511">#update_stat</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::Client</h1>
+
+ <div id="description">
+ <p>
Helpers for writing clients that can talk to agents, do discovery and so
forth
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000457">collective</a>
- <a href="#M000460">createreq</a>
- <a href="#M000458">disconnect</a>
- <a href="#M000464">discover</a>
- <a href="#M000471">discovered_req</a>
- <a href="#M000472">display_stats</a>
- <a href="#M000456">new</a>
- <a href="#M000463">receive</a>
- <a href="#M000465">req</a>
- <a href="#M000459">sendreq</a>
- <a href="#M000468">start_publisher</a>
- <a href="#M000469">start_receiver</a>
- <a href="#M000461">subscribe</a>
- <a href="#M000467">threaded_req</a>
- <a href="#M000462">unsubscribe</a>
- <a href="#M000466">unthreaded_req</a>
- <a href="#M000470">update_stat</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">discoverer</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">options</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">stats</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000456" class="method-detail">
- <a name="M000456"></a>
-
- <div class="method-heading">
- <a href="#M000456" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(configfile)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000456-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000456-source">
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="options-attribute-method" class="method-detail">
+ <a name="options"></a>
+
+ <a name="options="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">options</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="stats-attribute-method" class="method-detail">
+ <a name="stats"></a>
+
+ <a name="stats="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">stats</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="discoverer-attribute-method" class="method-detail">
+ <a name="discoverer"></a>
+
+ <a name="discoverer="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">discoverer</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="M000494"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(configfile)</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/client.rb, line 6</span>
6: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">configfile</span>)
16:
17: <span class="ruby-ivar">@discoverer</span> = <span class="ruby-constant">Discovery</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
18: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">connect</span>
-19: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000457" class="method-detail">
- <a name="M000457"></a>
-
- <div class="method-heading">
- <a href="#M000457" class="method-signature">
- <span class="method-name">collective</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns the configured main <a href="Client.html#M000457">collective</a> if
-no specific <a href="Client.html#M000457">collective</a> is specified as
-options
+19: <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="collective-method" class="method-detail ">
+ <a name="M000495"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">collective</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns the configured main collective if no specific collective is
+specified as options
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000457-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000457-source">
+
+
+
+ <div class="method-source-code"
+ id="collective-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 23</span>
23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">collective</span>
26: <span class="ruby-keyword kw">else</span>
27: <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:collective</span>]
28: <span class="ruby-keyword kw">end</span>
-29: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000460" class="method-detail">
- <a name="M000460"></a>
-
- <div class="method-heading">
- <a href="#M000460" class="method-signature">
- <span class="method-name">createreq</span><span class="method-args">(msg, agent, filter ={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000460-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000460-source">
+29: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="createreq-method" class="method-detail ">
+ <a name="M000498"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">createreq</span><span
+ class="method-args">(msg, agent, filter ={})</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="createreq-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 48</span>
48: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">createreq</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">filter</span> ={})
58: <span class="ruby-identifier">request</span>.<span class="ruby-identifier">encode!</span>
59: <span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:reply</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">request</span>.<span class="ruby-identifier">reply_to</span>
60: <span class="ruby-identifier">request</span>
-61: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000458" class="method-detail">
- <a name="M000458"></a>
-
- <div class="method-heading">
- <a href="#M000458" class="method-signature">
- <span class="method-name">disconnect</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+61: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="disconnect-method" class="method-detail ">
+ <a name="M000496"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">disconnect</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Disconnects cleanly from the middleware
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000458-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000458-source">
+
+
+
+ <div class="method-source-code"
+ id="disconnect-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 32</span>
32: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">disconnect</span>
33: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Disconnecting from the middleware"</span>)
34: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">disconnect</span>
-35: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000464" class="method-detail">
- <a name="M000464"></a>
-
- <div class="method-heading">
- <a href="#M000464" class="method-signature">
- <span class="method-name">discover</span><span class="method-args">(filter, timeout, limit=0)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+35: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discover-method" class="method-detail ">
+ <a name="M000502"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discover</span><span
+ class="method-args">(filter, timeout, limit=0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Performs a discovery of nodes matching the filter passed returns an array
of nodes
</p>
An integer limit can be supplied this will have the effect of the discovery
being cancelled soon as it reached the requested limit of hosts
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000464-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000464-source">
+
+
+
+ <div class="method-source-code"
+ id="discover-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 117</span>
117: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discover</span>(<span class="ruby-identifier">filter</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">limit</span>=<span class="ruby-value">0</span>)
118: <span class="ruby-identifier">discovered</span> = <span class="ruby-ivar">@discoverer</span>.<span class="ruby-identifier">discover</span>(<span class="ruby-identifier">filter</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">limit</span>)
-119: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000471" class="method-detail">
- <a name="M000471"></a>
-
- <div class="method-heading">
- <a href="#M000471" class="method-signature">
- <span class="method-name">discovered_req</span><span class="method-args">(body, agent, options=false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000471-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000471-source">
+119: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovered-req-method" class="method-detail ">
+ <a name="M000512"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovered_req</span><span
+ class="method-args">(body, agent, options=false)</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="discovered-req-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 233</span>
233: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovered_req</span>(<span class="ruby-identifier">body</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">options</span>=<span class="ruby-keyword kw">false</span>)
234: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Client#discovered_req has been removed, please port your agent and client to the SimpleRPC framework"</span>
-235: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000472" class="method-detail">
- <a name="M000472"></a>
-
- <div class="method-heading">
- <a href="#M000472" class="method-signature">
- <span class="method-name">display_stats</span><span class="method-args">(stats, options=false, caption="stomp call summary")</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Prints out the stats returns from <a href="Client.html#M000465">req</a> and
-<a href="Client.html#M000471">discovered_req</a> in a nice way
+235: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="display-stats-method" class="method-detail ">
+ <a name="M000513"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">display_stats</span><span
+ class="method-args">(stats, options=false, caption="stomp call summary")</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Prints out the stats returns from req and <a
+href="Client.html#M000512">discovered_req</a> in a nice way
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000472-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000472-source">
+
+
+
+ <div class="method-source-code"
+ id="display-stats-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 238</span>
238: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">display_stats</span>(<span class="ruby-identifier">stats</span>, <span class="ruby-identifier">options</span>=<span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">caption</span>=<span class="ruby-value str">"stomp call summary"</span>)
270:
271: <span class="ruby-identifier">puts</span>
272: <span class="ruby-keyword kw">end</span>
-273: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000463" class="method-detail">
- <a name="M000463"></a>
-
- <div class="method-heading">
- <a href="#M000463" class="method-signature">
- <span class="method-name">receive</span><span class="method-args">(requestid = nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+273: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="receive-method" class="method-detail ">
+ <a name="M000501"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">receive</span><span
+ class="method-args">(requestid = nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Blocking call that waits for ever for a message to arrive.
</p>
<p>
-If you give it a requestid this means you‘ve previously send a
+If you give it a requestid this means you’ve previously send a
request with that ID and now you just want replies that matches that id, in
that case the current connection will just ignore all messages not directed
at it and keep waiting for more till it finds a matching message.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000463-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000463-source">
+
+
+
+ <div class="method-source-code"
+ id="receive-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 88</span>
88: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">receive</span>(<span class="ruby-identifier">requestid</span> = <span class="ruby-keyword kw">nil</span>)
106: <span class="ruby-keyword kw">end</span>
107:
108: <span class="ruby-identifier">reply</span>
-109: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000465" class="method-detail">
- <a name="M000465"></a>
-
- <div class="method-heading">
- <a href="#M000465" class="method-signature">
- <span class="method-name">req</span><span class="method-args">(body, agent=nil, options=false, waitfor=0, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+109: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="req-method" class="method-detail ">
+ <a name="M000503"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">req</span><span
+ class="method-args">(body, agent=nil, options=false, waitfor=0, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Send a request, performs the passed block for each response
</p>
<p>
-times = <a href="Client.html#M000465">req</a>("status",
-"mcollectived", options, client) {|resp|
+times = req(“status”, “mcollectived”, options,
+client) {|resp|
</p>
<pre>
pp resp
taken from the options hash which in turn is generally built using <a
href="Optionparser.html">MCollective::Optionparser</a>
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000465-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000465-source">
+
+
+
+ <div class="method-source-code"
+ id="req-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 129</span>
129: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">req</span>(<span class="ruby-identifier">body</span>, <span class="ruby-identifier">agent</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">options</span>=<span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">waitfor</span>=<span class="ruby-value">0</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
155: <span class="ruby-keyword kw">end</span>
156:
157: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">update_stat</span>(<span class="ruby-identifier">stat</span>, <span class="ruby-identifier">hosts_responded</span>, <span class="ruby-identifier">request</span>.<span class="ruby-identifier">requestid</span>)
-158: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000459" class="method-detail">
- <a name="M000459"></a>
-
- <div class="method-heading">
- <a href="#M000459" class="method-signature">
- <span class="method-name">sendreq</span><span class="method-args">(msg, agent, filter = {})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sends a request and returns the generated request id, doesn‘t wait
-for responses and doesn‘t execute any passed in code blocks for
+158: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="sendreq-method" class="method-detail ">
+ <a name="M000497"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">sendreq</span><span
+ class="method-args">(msg, agent, filter = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sends a request and returns the generated request id, doesn’t wait
+for responses and doesn’t execute any passed in code blocks for
responses
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000459-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000459-source">
+
+
+
+ <div class="method-source-code"
+ id="sendreq-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 39</span>
39: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sendreq</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">filter</span> = {})
43:
44: <span class="ruby-identifier">request</span>.<span class="ruby-identifier">publish</span>
45: <span class="ruby-identifier">request</span>.<span class="ruby-identifier">requestid</span>
-46: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000468" class="method-detail">
- <a name="M000468"></a>
-
- <div class="method-heading">
- <a href="#M000468" class="method-signature">
- <span class="method-name">start_publisher</span><span class="method-args">(request, publish_timeout)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+46: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="start-publisher-method" class="method-detail ">
+ <a name="M000509"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">start_publisher</span><span
+ class="method-args">(request, publish_timeout)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Starts the request publishing routine
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000468-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000468-source">
+
+
+
+ <div class="method-source-code"
+ id="start-publisher-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 191</span>
191: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start_publisher</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">publish_timeout</span>)
198: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
199: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-value str">"Could not publish all messages. Publishing timed out."</span>)
200: <span class="ruby-keyword kw">end</span>
-201: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000469" class="method-detail">
- <a name="M000469"></a>
-
- <div class="method-heading">
- <a href="#M000469" class="method-signature">
- <span class="method-name">start_receiver</span><span class="method-args">(requestid, waitfor, timeout) {|resp.payload| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+201: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="start-receiver-method" class="method-detail ">
+ <a name="M000510"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">start_receiver</span><span
+ class="method-args">(requestid, waitfor, timeout, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Starts the response receiver routine Expected to return the amount of
received responses.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000469-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000469-source">
+
+
+
+ <div class="method-source-code"
+ id="start-receiver-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 205</span>
205: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start_receiver</span>(<span class="ruby-identifier">requestid</span>, <span class="ruby-identifier">waitfor</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
218: <span class="ruby-keyword kw">end</span>
219:
220: <span class="ruby-identifier">hosts_responded</span>
-221: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000461" class="method-detail">
- <a name="M000461"></a>
-
- <div class="method-heading">
- <a href="#M000461" class="method-signature">
- <span class="method-name">subscribe</span><span class="method-args">(agent, type)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000461-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000461-source">
+221: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="subscribe-method" class="method-detail ">
+ <a name="M000499"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">subscribe</span><span
+ class="method-args">(agent, type)</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="subscribe-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 63</span>
63: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">type</span>)
68: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">subscription</span>)
69: <span class="ruby-ivar">@subscriptions</span>[<span class="ruby-identifier">agent</span>] = <span class="ruby-value">1</span>
70: <span class="ruby-keyword kw">end</span>
-71: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000467" class="method-detail">
- <a name="M000467"></a>
-
- <div class="method-heading">
- <a href="#M000467" class="method-signature">
- <span class="method-name">threaded_req</span><span class="method-args">(request, publish_timeout, timeout, waitfor, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+71: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="threaded-req-method" class="method-detail ">
+ <a name="M000505"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">threaded_req</span><span
+ class="method-args">(request, publish_timeout, timeout, waitfor, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Starts the client receiver and publisher in threads. This is activated when
the ‘threader_client’ configuration option is set.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000467-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000467-source">
+
+
+
+ <div class="method-source-code"
+ id="threaded-req-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 170</span>
170: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">threaded_req</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">publish_timeout</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">waitfor</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
185:
186: <span class="ruby-identifier">receiver</span>.<span class="ruby-identifier">join</span>
187: <span class="ruby-identifier">hosts_responded</span>
-188: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000462" class="method-detail">
- <a name="M000462"></a>
-
- <div class="method-heading">
- <a href="#M000462" class="method-signature">
- <span class="method-name">unsubscribe</span><span class="method-args">(agent, type)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000462-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000462-source">
+188: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="unsubscribe-method" class="method-detail ">
+ <a name="M000500"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">unsubscribe</span><span
+ class="method-args">(agent, type)</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="unsubscribe-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 73</span>
73: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unsubscribe</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">type</span>)
78: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">unsubscribe</span>(<span class="ruby-identifier">subscription</span>)
79: <span class="ruby-ivar">@subscriptions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">agent</span>)
80: <span class="ruby-keyword kw">end</span>
-81: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000466" class="method-detail">
- <a name="M000466"></a>
-
- <div class="method-heading">
- <a href="#M000466" class="method-signature">
- <span class="method-name">unthreaded_req</span><span class="method-args">(request, publish_timeout, timeout, waitfor, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+81: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="unthreaded-req-method" class="method-detail ">
+ <a name="M000504"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">unthreaded_req</span><span
+ class="method-args">(request, publish_timeout, timeout, waitfor, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Starts the client receiver and publisher unthreaded. This is the default
client behaviour.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000466-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000466-source">
+
+
+
+ <div class="method-source-code"
+ id="unthreaded-req-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 162</span>
162: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unthreaded_req</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">publish_timeout</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">waitfor</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
163: <span class="ruby-identifier">start_publisher</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">publish_timeout</span>)
164: <span class="ruby-identifier">start_receiver</span>(<span class="ruby-identifier">request</span>.<span class="ruby-identifier">requestid</span>, <span class="ruby-identifier">waitfor</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-165: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000470" class="method-detail">
- <a name="M000470"></a>
-
- <div class="method-heading">
- <a href="#M000470" class="method-signature">
- <span class="method-name">update_stat</span><span class="method-args">(stat, hosts_responded, requestid)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000470-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000470-source">
+165: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="update-stat-method" class="method-detail ">
+ <a name="M000511"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">update_stat</span><span
+ class="method-args">(stat, hosts_responded, requestid)</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="update-stat-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/client.rb, line 223</span>
223: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">update_stat</span>(<span class="ruby-identifier">stat</span>, <span class="ruby-identifier">hosts_responded</span>, <span class="ruby-identifier">requestid</span>)
228: <span class="ruby-identifier">stat</span>[<span class="ruby-identifier">:requestid</span>] = <span class="ruby-identifier">requestid</span>
229:
230: <span class="ruby-ivar">@stats</span> = <span class="ruby-identifier">stat</span>
-231: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+231: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </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>
-</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>
\ No newline at end of file
+</html>
+
--- /dev/null
+<?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::CodedError</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">RuntimeError</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="#M000506">::new</a></li>
+
+ <li><a href="#M000508">#log</a></li>
+
+ <li><a href="#M000507">#set_backtrace</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::CodedError</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="code-attribute-method" class="method-detail">
+ <a name="code"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">code</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="args-attribute-method" class="method-detail">
+ <a name="args"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">args</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="log-level-attribute-method" class="method-detail">
+ <a name="log_level"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">log_level</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="default-attribute-method" class="method-detail">
+ <a name="default"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">default</span><span
+ class="attribute-access-type">[R]</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="M000506"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(msgid, default, level=:debug, args={})</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/exception.rb, line 5</span>
+ 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>=<span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">args</span>={})
+ 6: <span class="ruby-ivar">@code</span> = <span class="ruby-identifier">msgid</span>
+ 7: <span class="ruby-ivar">@log_level</span> = <span class="ruby-identifier">level</span>
+ 8: <span class="ruby-ivar">@args</span> = <span class="ruby-identifier">args</span>
+ 9: <span class="ruby-ivar">@default</span> = <span class="ruby-identifier">default</span>
+10:
+11: <span class="ruby-identifier">msg</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-ivar">@code</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-ivar">@args</span>))
+12:
+13: <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">msg</span>)
+14: <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="log-method" class="method-detail ">
+ <a name="M000508"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">log</span><span
+ class="method-args">(level, log_backtrace=false)</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="log-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/exception.rb, line 21</span>
+21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">log_backtrace</span>=<span class="ruby-keyword kw">false</span>)
+22: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">logexception</span>(<span class="ruby-ivar">@code</span>, <span class="ruby-identifier">level</span>, <span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">log_backtrace</span>)
+23: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="set-backtrace-method" class="method-detail ">
+ <a name="M000507"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">set_backtrace</span><span
+ class="method-args">(trace)</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="set-backtrace-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/exception.rb, line 16</span>
+16: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_backtrace</span>(<span class="ruby-identifier">trace</span>)
+17: <span class="ruby-keyword kw">super</span>
+18: <span class="ruby-identifier">log</span>(<span class="ruby-ivar">@log_level</span>)
+19: <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>
+
--- /dev/null
+<?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::Config</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/config_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/config.rb">lib/mcollective/config.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="#M000110">::new</a></li>
+
+ <li><a href="#M000111">#loadconfig</a></li>
+
+ <li><a href="#M000114">#read_plugin_config_dir</a></li>
+
+ <li><a href="#M000113">#set_config_defaults</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ <div id="includes-section" class="section">
+ <h3 class="section-header">Included Modules</h3>
+ <ul class="link-list">
+
+
+ <li><span class="include">Singleton</span></li>
+
+
+ </ul>
+ </div>
+
+ </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::Config</h1>
+
+ <div id="description">
+ <p>
+A pretty sucky config class, ripe for refactoring/improving
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="mode-attribute-method" class="method-detail">
+ <a name="mode"></a>
+
+ <a name="mode="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">mode</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="daemonize-attribute-method" class="method-detail">
+ <a name="daemonize"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">daemonize</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="pluginconf-attribute-method" class="method-detail">
+ <a name="pluginconf"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">pluginconf</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="libdir-attribute-method" class="method-detail">
+ <a name="libdir"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">libdir</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="configured-attribute-method" class="method-detail">
+ <a name="configured"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">configured</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="logfile-attribute-method" class="method-detail">
+ <a name="logfile"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">logfile</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="keeplogs-attribute-method" class="method-detail">
+ <a name="keeplogs"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">keeplogs</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="max-log-size-attribute-method" class="method-detail">
+ <a name="max_log_size"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">max_log_size</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="loglevel-attribute-method" class="method-detail">
+ <a name="loglevel"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">loglevel</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="logfacility-attribute-method" class="method-detail">
+ <a name="logfacility"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">logfacility</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="identity-attribute-method" class="method-detail">
+ <a name="identity"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">identity</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="daemonize-attribute-method" class="method-detail">
+ <a name="daemonize"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">daemonize</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="connector-attribute-method" class="method-detail">
+ <a name="connector"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">connector</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="securityprovider-attribute-method" class="method-detail">
+ <a name="securityprovider"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">securityprovider</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="factsource-attribute-method" class="method-detail">
+ <a name="factsource"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">factsource</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="registration-attribute-method" class="method-detail">
+ <a name="registration"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">registration</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="registerinterval-attribute-method" class="method-detail">
+ <a name="registerinterval"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">registerinterval</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="classesfile-attribute-method" class="method-detail">
+ <a name="classesfile"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">classesfile</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="rpcauditprovider-attribute-method" class="method-detail">
+ <a name="rpcauditprovider"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">rpcauditprovider</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="rpcaudit-attribute-method" class="method-detail">
+ <a name="rpcaudit"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">rpcaudit</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="configdir-attribute-method" class="method-detail">
+ <a name="configdir"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">configdir</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="rpcauthprovider-attribute-method" class="method-detail">
+ <a name="rpcauthprovider"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">rpcauthprovider</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="rpcauthorization-attribute-method" class="method-detail">
+ <a name="rpcauthorization"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">rpcauthorization</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="color-attribute-method" class="method-detail">
+ <a name="color"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">color</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="configfile-attribute-method" class="method-detail">
+ <a name="configfile"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">configfile</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="rpclimitmethod-attribute-method" class="method-detail">
+ <a name="rpclimitmethod"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">rpclimitmethod</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="logger-type-attribute-method" class="method-detail">
+ <a name="logger_type"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">logger_type</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="fact-cache-time-attribute-method" class="method-detail">
+ <a name="fact_cache_time"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">fact_cache_time</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="collectives-attribute-method" class="method-detail">
+ <a name="collectives"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">collectives</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="main-collective-attribute-method" class="method-detail">
+ <a name="main_collective"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">main_collective</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ssl-cipher-attribute-method" class="method-detail">
+ <a name="ssl_cipher"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ssl_cipher</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="registration-collective-attribute-method" class="method-detail">
+ <a name="registration_collective"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">registration_collective</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="direct-addressing-attribute-method" class="method-detail">
+ <a name="direct_addressing"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">direct_addressing</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="direct-addressing-threshold-attribute-method" class="method-detail">
+ <a name="direct_addressing_threshold"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">direct_addressing_threshold</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ttl-attribute-method" class="method-detail">
+ <a name="ttl"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ttl</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="default-discovery-method-attribute-method" class="method-detail">
+ <a name="default_discovery_method"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">default_discovery_method</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="default-discovery-options-attribute-method" class="method-detail">
+ <a name="default_discovery_options"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">default_discovery_options</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="publish-timeout-attribute-method" class="method-detail">
+ <a name="publish_timeout"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">publish_timeout</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="threaded-attribute-method" class="method-detail">
+ <a name="threaded"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">threaded</span><span
+ class="attribute-access-type">[R]</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="M000110"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">()</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/config.rb, line 20</span>
+20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+21: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">false</span>
+22: <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="loadconfig-method" class="method-detail ">
+ <a name="M000111"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">loadconfig</span><span
+ class="method-args">(configfile)</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="loadconfig-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/config.rb, line 24</span>
+ 24: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">loadconfig</span>(<span class="ruby-identifier">configfile</span>)
+ 25: <span class="ruby-identifier">set_config_defaults</span>(<span class="ruby-identifier">configfile</span>)
+ 26:
+ 27: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">configfile</span>)
+ 28: <span class="ruby-constant">File</span>.<span class="ruby-identifier">readlines</span>(<span class="ruby-identifier">configfile</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
+ 29:
+ 30: <span class="ruby-comment cmt"># strip blank spaces, tabs etc off the end of all lines</span>
+ 31: <span class="ruby-identifier">line</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/\s*$/</span>, <span class="ruby-value str">""</span>)
+ 32:
+ 33: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">line</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^#|^$/</span>
+ 34: <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">line</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/(.+?)\s*=\s*(.+)/</span>)
+ 35: <span class="ruby-identifier">key</span> = <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">strip</span>
+ 36: <span class="ruby-identifier">val</span> = <span class="ruby-identifier">$2</span>
+ 37:
+ 38: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">key</span>
+ 39: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"registration"</span>
+ 40: <span class="ruby-ivar">@registration</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">capitalize</span>
+ 41: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"registration_collective"</span>
+ 42: <span class="ruby-ivar">@registration_collective</span> = <span class="ruby-identifier">val</span>
+ 43: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"registerinterval"</span>
+ 44: <span class="ruby-ivar">@registerinterval</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
+ 45: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"collectives"</span>
+ 46: <span class="ruby-ivar">@collectives</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">","</span>).<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">strip</span>}
+ 47: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"main_collective"</span>
+ 48: <span class="ruby-ivar">@main_collective</span> = <span class="ruby-identifier">val</span>
+ 49: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"logfile"</span>
+ 50: <span class="ruby-ivar">@logfile</span> = <span class="ruby-identifier">val</span>
+ 51: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"keeplogs"</span>
+ 52: <span class="ruby-ivar">@keeplogs</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
+ 53: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"max_log_size"</span>
+ 54: <span class="ruby-ivar">@max_log_size</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
+ 55: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"loglevel"</span>
+ 56: <span class="ruby-ivar">@loglevel</span> = <span class="ruby-identifier">val</span>
+ 57: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"logfacility"</span>
+ 58: <span class="ruby-ivar">@logfacility</span> = <span class="ruby-identifier">val</span>
+ 59: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"libdir"</span>
+ 60: <span class="ruby-identifier">paths</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">split</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">PATH_SEPARATOR</span>)
+ 61: <span class="ruby-identifier">paths</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
+ 62: <span class="ruby-identifier">raise</span>(<span class="ruby-value str">"libdir paths should be absolute paths but '%s' is relative"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">path</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">absolute_path?</span>(<span class="ruby-identifier">path</span>)
+ 63:
+ 64: <span class="ruby-ivar">@libdir</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">path</span>
+ 65: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">$LOAD_PATH</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">path</span>)
+ 66: <span class="ruby-identifier">$LOAD_PATH</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">path</span>
+ 67: <span class="ruby-keyword kw">end</span>
+ 68: <span class="ruby-keyword kw">end</span>
+ 69: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"identity"</span>
+ 70: <span class="ruby-ivar">@identity</span> = <span class="ruby-identifier">val</span>
+ 71: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"direct_addressing"</span>
+ 72: <span class="ruby-ivar">@direct_addressing</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
+ 73: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"direct_addressing_threshold"</span>
+ 74: <span class="ruby-ivar">@direct_addressing_threshold</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
+ 75: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"color"</span>
+ 76: <span class="ruby-ivar">@color</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
+ 77: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"daemonize"</span>
+ 78: <span class="ruby-ivar">@daemonize</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
+ 79: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"securityprovider"</span>
+ 80: <span class="ruby-ivar">@securityprovider</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">capitalize</span>
+ 81: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"factsource"</span>
+ 82: <span class="ruby-ivar">@factsource</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">capitalize</span>
+ 83: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"connector"</span>
+ 84: <span class="ruby-ivar">@connector</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">capitalize</span>
+ 85: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"classesfile"</span>
+ 86: <span class="ruby-ivar">@classesfile</span> = <span class="ruby-identifier">val</span>
+ 87: <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/^plugin.(.+)$/</span>
+ 88: <span class="ruby-ivar">@pluginconf</span>[<span class="ruby-identifier">$1</span>] = <span class="ruby-identifier">val</span>
+ 89: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"publish_timeout"</span>
+ 90: <span class="ruby-ivar">@publish_timeout</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
+ 91: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"rpcaudit"</span>
+ 92: <span class="ruby-ivar">@rpcaudit</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
+ 93: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"rpcauditprovider"</span>
+ 94: <span class="ruby-ivar">@rpcauditprovider</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">capitalize</span>
+ 95: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"rpcauthorization"</span>
+ 96: <span class="ruby-ivar">@rpcauthorization</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
+ 97: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"rpcauthprovider"</span>
+ 98: <span class="ruby-ivar">@rpcauthprovider</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">capitalize</span>
+ 99: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"rpclimitmethod"</span>
+100: <span class="ruby-ivar">@rpclimitmethod</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_sym</span>
+101: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"logger_type"</span>
+102: <span class="ruby-ivar">@logger_type</span> = <span class="ruby-identifier">val</span>
+103: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"fact_cache_time"</span>
+104: <span class="ruby-ivar">@fact_cache_time</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
+105: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"ssl_cipher"</span>
+106: <span class="ruby-ivar">@ssl_cipher</span> = <span class="ruby-identifier">val</span>
+107: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"threaded"</span>
+108: <span class="ruby-ivar">@threaded</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
+109: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"ttl"</span>
+110: <span class="ruby-ivar">@ttl</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
+111: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"default_discovery_options"</span>
+112: <span class="ruby-ivar">@default_discovery_options</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">val</span>
+113: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"default_discovery_method"</span>
+114: <span class="ruby-ivar">@default_discovery_method</span> = <span class="ruby-identifier">val</span>
+115: <span class="ruby-keyword kw">else</span>
+116: <span class="ruby-identifier">raise</span>(<span class="ruby-node">"Unknown config parameter '#{key}'"</span>)
+117: <span class="ruby-keyword kw">end</span>
+118: <span class="ruby-keyword kw">end</span>
+119: <span class="ruby-keyword kw">end</span>
+120: <span class="ruby-keyword kw">end</span>
+121:
+122: <span class="ruby-identifier">raise</span>(<span class="ruby-value str">'The %s config file does not specify a libdir setting, cannot continue'</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">configfile</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@libdir</span>.<span class="ruby-identifier">empty?</span>
+123:
+124: <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">load_path</span> = <span class="ruby-constant">Dir</span>[<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">"locales"</span>, <span class="ruby-value str">"*.yml"</span>))]
+125: <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">locale</span> = <span class="ruby-identifier">:en</span>
+126:
+127: <span class="ruby-identifier">read_plugin_config_dir</span>(<span class="ruby-node">"#{@configdir}/plugin.d"</span>)
+128:
+129: <span class="ruby-identifier">raise</span> <span class="ruby-value str">'Identities can only match /\w\.\-/'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@identity</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^[\w\.\-]+$/</span>)
+130:
+131: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">true</span>
+132:
+133: <span class="ruby-ivar">@libdir</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">dir</span><span class="ruby-operator">|</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Cannot find libdir: #{dir}"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">dir</span>)}
+134:
+135: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@logger_type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"syslog"</span>
+136: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"The sylog logger is not usable on the Windows platform"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
+137: <span class="ruby-keyword kw">end</span>
+138:
+139: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"Mcollective::Facts::#{@factsource}_facts"</span>)
+140: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"Mcollective::Connector::#{@connector}"</span>)
+141: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"Mcollective::Security::#{@securityprovider}"</span>)
+142: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"Mcollective::Registration::#{@registration}"</span>)
+143: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"Mcollective::Audit::#{@rpcauditprovider}"</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@rpcaudit</span>
+144: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"global_stats"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-constant">RunnerStats</span>.<span class="ruby-identifier">new</span>}
+145:
+146: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">logmsg</span>(<span class="ruby-identifier">:PLMC1</span>, <span class="ruby-value str">"The Marionette Collective version %{version} started by %{name} using config file %{config}"</span>, <span class="ruby-identifier">:info</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>, <span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">$0</span>, <span class="ruby-identifier">:config</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">configfile</span>)
+147: <span class="ruby-keyword kw">else</span>
+148: <span class="ruby-identifier">raise</span>(<span class="ruby-node">"Cannot find config file '#{configfile}'"</span>)
+149: <span class="ruby-keyword kw">end</span>
+150: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="read-plugin-config-dir-method" class="method-detail ">
+ <a name="M000114"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">read_plugin_config_dir</span><span
+ class="method-args">(dir)</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="read-plugin-config-dir-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/config.rb, line 192</span>
+192: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read_plugin_config_dir</span>(<span class="ruby-identifier">dir</span>)
+193: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">dir</span>)
+194:
+195: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">dir</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pluginconfigfile</span><span class="ruby-operator">|</span>
+196: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">pluginconfigfile</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^([\w]+).cfg$/</span>
+197:
+198: <span class="ruby-identifier">plugin</span> = <span class="ruby-identifier">$1</span>
+199: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-node">"#{dir}/#{pluginconfigfile}"</span>, <span class="ruby-value str">"r"</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
+200: <span class="ruby-comment cmt"># strip blank lines</span>
+201: <span class="ruby-identifier">line</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/\s*$/</span>, <span class="ruby-value str">""</span>)
+202: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">line</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^#|^$/</span>
+203: <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">line</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/(.+?)\s*=\s*(.+)/</span>)
+204: <span class="ruby-identifier">key</span> = <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">strip</span>
+205: <span class="ruby-identifier">val</span> = <span class="ruby-identifier">$2</span>
+206: <span class="ruby-ivar">@pluginconf</span>[<span class="ruby-node">"#{plugin}.#{key}"</span>] = <span class="ruby-identifier">val</span>
+207: <span class="ruby-keyword kw">end</span>
+208: <span class="ruby-keyword kw">end</span>
+209: <span class="ruby-keyword kw">end</span>
+210: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="set-config-defaults-method" class="method-detail ">
+ <a name="M000113"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">set_config_defaults</span><span
+ class="method-args">(configfile)</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="set-config-defaults-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/config.rb, line 152</span>
+152: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_config_defaults</span>(<span class="ruby-identifier">configfile</span>)
+153: <span class="ruby-ivar">@stomp</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
+154: <span class="ruby-ivar">@subscribe</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
+155: <span class="ruby-ivar">@pluginconf</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
+156: <span class="ruby-ivar">@connector</span> = <span class="ruby-value str">"activemq"</span>
+157: <span class="ruby-ivar">@securityprovider</span> = <span class="ruby-value str">"Psk"</span>
+158: <span class="ruby-ivar">@factsource</span> = <span class="ruby-value str">"Yaml"</span>
+159: <span class="ruby-ivar">@identity</span> = <span class="ruby-constant">Socket</span>.<span class="ruby-identifier">gethostname</span>
+160: <span class="ruby-ivar">@registration</span> = <span class="ruby-value str">"Agentlist"</span>
+161: <span class="ruby-ivar">@registerinterval</span> = <span class="ruby-value">0</span>
+162: <span class="ruby-ivar">@registration_collective</span> = <span class="ruby-keyword kw">nil</span>
+163: <span class="ruby-ivar">@classesfile</span> = <span class="ruby-value str">"/var/lib/puppet/state/classes.txt"</span>
+164: <span class="ruby-ivar">@rpcaudit</span> = <span class="ruby-keyword kw">false</span>
+165: <span class="ruby-ivar">@rpcauditprovider</span> = <span class="ruby-value str">""</span>
+166: <span class="ruby-ivar">@rpcauthorization</span> = <span class="ruby-keyword kw">false</span>
+167: <span class="ruby-ivar">@rpcauthprovider</span> = <span class="ruby-value str">""</span>
+168: <span class="ruby-ivar">@configdir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">configfile</span>)
+169: <span class="ruby-ivar">@color</span> = <span class="ruby-operator">!</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
+170: <span class="ruby-ivar">@configfile</span> = <span class="ruby-identifier">configfile</span>
+171: <span class="ruby-ivar">@logger_type</span> = <span class="ruby-value str">"file"</span>
+172: <span class="ruby-ivar">@keeplogs</span> = <span class="ruby-value">5</span>
+173: <span class="ruby-ivar">@max_log_size</span> = <span class="ruby-value">2097152</span>
+174: <span class="ruby-ivar">@rpclimitmethod</span> = <span class="ruby-identifier">:first</span>
+175: <span class="ruby-ivar">@libdir</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
+176: <span class="ruby-ivar">@fact_cache_time</span> = <span class="ruby-value">300</span>
+177: <span class="ruby-ivar">@loglevel</span> = <span class="ruby-value str">"info"</span>
+178: <span class="ruby-ivar">@logfacility</span> = <span class="ruby-value str">"user"</span>
+179: <span class="ruby-ivar">@collectives</span> = [<span class="ruby-value str">"mcollective"</span>]
+180: <span class="ruby-ivar">@main_collective</span> = <span class="ruby-ivar">@collectives</span>.<span class="ruby-identifier">first</span>
+181: <span class="ruby-ivar">@ssl_cipher</span> = <span class="ruby-value str">"aes-256-cbc"</span>
+182: <span class="ruby-ivar">@direct_addressing</span> = <span class="ruby-keyword kw">true</span>
+183: <span class="ruby-ivar">@direct_addressing_threshold</span> = <span class="ruby-value">10</span>
+184: <span class="ruby-ivar">@default_discovery_method</span> = <span class="ruby-value str">"mc"</span>
+185: <span class="ruby-ivar">@default_discovery_options</span> = []
+186: <span class="ruby-ivar">@ttl</span> = <span class="ruby-value">60</span>
+187: <span class="ruby-ivar">@mode</span> = <span class="ruby-identifier">:client</span>
+188: <span class="ruby-ivar">@publish_timeout</span> = <span class="ruby-value">2</span>
+189: <span class="ruby-ivar">@threaded</span> = <span class="ruby-keyword kw">false</span>
+190: <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>
+
--- /dev/null
+<?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>Module: MCollective::Connector</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="module">
+
+ <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/connector_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/connector.rb">lib/mcollective/connector.rb</a></li>
+
+ <li><a href="../lib/mcollective/connector/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/connector/base.rb">lib/mcollective/connector/base.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="Connector/Base.html">MCollective::Connector::Base</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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="module">MCollective::Connector</h1>
+
+ <div id="description">
+ <p>
+Connectors take care of transporting messages between clients and agents,
+the design doesn’t your middleware to be very rich in features. All
+it really needs is the ability to send and receive messages to named
+queues/topics.
+</p>
+<p>
+At present there are assumptions about the naming of topics and queues that
+is compatible with Stomp, ie.
+</p>
+<p>
+/topic/foo.bar/baz /queue/foo.bar/baz
+</p>
+<p>
+This is the only naming format that is supported, but you could replace
+Stomp with something else that supports the above, see
+MCollective::Connector::Stomp for the default connector.
+</p>
+<hr size="1"></hr><p>
+<a href="Connector.html">Connector</a> plugins handle the communications
+with the middleware, you can provide your own to speak to something other
+than Stomp, your plugins must inherit from <a
+href="Connector/Base.html">MCollective::Connector::Base</a> and should
+provide the following methods:
+</p>
+<p>
+connect - Creates a connection to the middleware, no arguments should get
+its parameters from the config receive - Receive data from the middleware,
+should act like a blocking call only returning if/when data
+</p>
+<pre>
+ was received. It should get data from all subscribed channels/topics. Individual messages
+ should be returned as MCollective::Request objects with the payload provided
+</pre>
+<p>
+publish - Takes a target and msg, should send the message to the supplied
+target topic or destination subscribe - Adds a subscription to a specific
+message source unsubscribe - Removes a subscription to a specific message
+source disconnect - Disconnects from the middleware
+</p>
+<p>
+These methods are all that’s needed for a new connector protocol and
+should hopefully be simple enough to not have tied us to Stomp.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::Connector::Base</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/connector/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/connector/base.rb">lib/mcollective/connector/base.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="#M000293">::inherited</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::Connector::Base</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="inherited-method" class="method-detail ">
+ <a name="M000293"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">inherited</span><span
+ class="method-args">(klass)</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="inherited-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/connector/base.rb, line 19</span>
+19: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
+20: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"connector_plugin"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>}
+21: <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>
+
--- /dev/null
+<?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>Module: MCollective::DDL</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="module">
+
+ <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/ddl/discoveryddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/discoveryddl.rb">lib/mcollective/ddl/discoveryddl.rb</a></li>
+
+ <li><a href="../lib/mcollective/ddl/validatorddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/validatorddl.rb">lib/mcollective/ddl/validatorddl.rb</a></li>
+
+ <li><a href="../lib/mcollective/ddl/agentddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/agentddl.rb">lib/mcollective/ddl/agentddl.rb</a></li>
+
+ <li><a href="../lib/mcollective/ddl/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/base.rb">lib/mcollective/ddl/base.rb</a></li>
+
+ <li><a href="../lib/mcollective/ddl/dataddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/dataddl.rb">lib/mcollective/ddl/dataddl.rb</a></li>
+
+ <li><a href="../lib/mcollective/ddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl.rb">lib/mcollective/ddl.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
+
+ <li><span class="type">CLASS</span> <a href="DDL/Base.html">MCollective::DDL::Base</a></li>
+
+ <li><span class="type">CLASS</span> <a href="DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
+
+ <li><span class="type">CLASS</span> <a href="DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
+
+ <li><span class="type">CLASS</span> <a href="DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000368">::load_and_cache</a></li>
+
+ <li><a href="#M000367">::new</a></li>
+
+ <li><a href="#M000369">::string_to_boolean</a></li>
+
+ <li><a href="#M000370">::string_to_number</a></li>
+
+ <li><a href="#M000371">::validation_fail!</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="module">MCollective::DDL</h1>
+
+ <div id="description">
+ <p>
+A set of classes that helps create data description language files for
+plugins. You can define meta data, actions, input and output describing the
+behavior of your agent or other plugins
+</p>
+<p>
+<a href="DDL.html">DDL</a> files are used for input validation,
+constructing outputs, producing online help, informing the various display
+routines and so forth.
+</p>
+<p>
+A sample <a href="DDL.html">DDL</a> for an agent be seen below, you’d
+put this in your agent dir as <agent name>.ddl
+</p>
+<pre>
+ metadata :name => "SimpleRPC Service Agent",
+ :description => "Agent to manage services using the Puppet service provider",
+ :author => "R.I.Pienaar",
+ :license => "GPLv2",
+ :version => "1.1",
+ :url => "http://mcollective-plugins.googlecode.com/",
+ :timeout => 60
+
+ action "status", :description => "Gets the status of a service" do
+ display :always
+
+ input :service,
+ :prompt => "Service Name",
+ :description => "The service to get the status for",
+ :type => :string,
+ :validation => '^[a-zA-Z\-_\d]+$',
+ :optional => true,
+ :maxlength => 30
+
+ output :status,
+ :description => "The status of service",
+ :display_as => "Service Status"
+ end
+</pre>
+<p>
+There are now many types of <a href="DDL.html">DDL</a> and ultimately all
+pugins should have <a href="DDL.html">DDL</a> files. The code is organized
+so that any plugin type will magically just work - they will be an instane
+of <a href="DDL/Base.html">Base</a> which has metadata and a few common
+cases.
+</p>
+<p>
+For plugin types that require more specific behaviors they can just add a
+class here that inherits from <a href="DDL/Base.html">Base</a> and add
+their specific behavior.
+</p>
+<p>
+<a href="DDL/Base.html">Base</a> defines a specific behavior for input,
+output and metadata which we’d like to keep standard across plugin
+types so do not completely override the behavior of input. The methods are
+written that they will gladly store extra content though so you add, do not
+remove. See the <a href="DDL/AgentDDL.html">AgentDDL</a> class for an
+example where agents want a :required argument to be always set.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="load-and-cache-method" class="method-detail ">
+ <a name="M000368"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_and_cache</span><span
+ class="method-args">(*args)</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="load-and-cache-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl.rb, line 71</span>
+71: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_and_cache</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+72: <span class="ruby-constant">Cache</span>.<span class="ruby-identifier">setup</span>(<span class="ruby-identifier">:ddl</span>, <span class="ruby-value">300</span>)
+73:
+74: <span class="ruby-identifier">plugin</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">first</span>
+75: <span class="ruby-identifier">args</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">type</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_s</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">type</span> = <span class="ruby-value str">"agent"</span>
+76: <span class="ruby-identifier">path</span> = <span class="ruby-value str">"%s/%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">type</span>, <span class="ruby-identifier">plugin</span>]
+77:
+78: <span class="ruby-keyword kw">begin</span>
+79: <span class="ruby-identifier">ddl</span> = <span class="ruby-constant">Cache</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">:ddl</span>, <span class="ruby-identifier">path</span>)
+80: <span class="ruby-keyword kw">rescue</span>
+81: <span class="ruby-keyword kw">begin</span>
+82: <span class="ruby-identifier">klass</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-value str">"%sDDL"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">capitalize</span>)
+83: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NameError</span>
+84: <span class="ruby-identifier">klass</span> = <span class="ruby-constant">Base</span>
+85: <span class="ruby-keyword kw">end</span>
+86:
+87: <span class="ruby-identifier">ddl</span> = <span class="ruby-constant">Cache</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">:ddl</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>))
+88: <span class="ruby-keyword kw">end</span>
+89:
+90: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">ddl</span>
+91: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="new-method" class="method-detail ">
+ <a name="M000367"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(*args, &blk)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+There used to be only one big nasty <a href="DDL.html">DDL</a> class with a
+bunch of mashed together behaviors. It’s been around for ages and we
+would rather not ask all the users to change their <a
+href="DDL.html#M000367">DDL.new</a> calls to some other factory method that
+would have this exact same behavior.
+</p>
+<p>
+So we override the behavior of <a href="DDL.html#M000367">new</a> which is
+a hugely sucky thing to do but ultimately it’s what would be least
+disrupting to code out there today. We did though change <a
+href="DDL.html">DDL</a> to a module to make it possibly a little less
+suprising, possibly.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="new-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl.rb, line 67</span>
+67: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>)
+68: <span class="ruby-identifier">load_and_cache</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+69: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="string-to-boolean-method" class="method-detail ">
+ <a name="M000369"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">string_to_boolean</span><span
+ class="method-args">(val)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+As we’re taking arguments on the command line we need a way to input
+booleans, true on the cli is a string so this method will take the ddl,
+find all arguments that are supposed to be boolean and if they are the
+strings “true”/“yes” or
+“false”/“no” turn them into the matching boolean
+</p>
+
+
+
+ <div class="method-source-code"
+ id="string-to-boolean-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl.rb, line 98</span>
+ 98: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">string_to_boolean</span>(<span class="ruby-identifier">val</span>)
+ 99: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> [<span class="ruby-value str">"true"</span>, <span class="ruby-value str">"t"</span>, <span class="ruby-value str">"yes"</span>, <span class="ruby-value str">"y"</span>, <span class="ruby-value str">"1"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">val</span>.<span class="ruby-identifier">downcase</span>)
+100: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">if</span> [<span class="ruby-value str">"false"</span>, <span class="ruby-value str">"f"</span>, <span class="ruby-value str">"no"</span>, <span class="ruby-value str">"n"</span>, <span class="ruby-value str">"0"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">val</span>.<span class="ruby-identifier">downcase</span>)
+101:
+102: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC17</span>, <span class="ruby-value str">"%{value} does not look like a boolean argument"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">val</span>)
+103: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="string-to-number-method" class="method-detail ">
+ <a name="M000370"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">string_to_number</span><span
+ class="method-args">(val)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+a generic string to number function, if a number looks like a float it
+turns it into a float else an int. This is naive but should be sufficient
+for numbers typed on the cli in most cases
+</p>
+
+
+
+ <div class="method-source-code"
+ id="string-to-number-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl.rb, line 108</span>
+108: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">string_to_number</span>(<span class="ruby-identifier">val</span>)
+109: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">val</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^\d+\.\d+$/</span>
+110: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">val</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^\d+$/</span>
+111:
+112: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC16</span>, <span class="ruby-value str">"%{value} does not look like a numeric value"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">val</span>)
+113: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validation-fail--method" class="method-detail ">
+ <a name="M000371"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validation_fail!</span><span
+ class="method-args">(code, default, level, args={})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Various <a href="DDL.html">DDL</a> implementations will validate and raise
+on error, this is a utility method to correctly setup a <a
+href="DDLValidationError.html">DDLValidationError</a> exceptions and raise
+them
+</p>
+
+
+
+ <div class="method-source-code"
+ id="validation-fail--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl.rb, line 117</span>
+117: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">code</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>={})
+118: <span class="ruby-identifier">exception</span> = <span class="ruby-constant">DDLValidationError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">code</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>)
+119: <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">set_backtrace</span> <span class="ruby-identifier">caller</span>
+120:
+121: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">exception</span>
+122: <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>
+
--- /dev/null
+<?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::DDL::AgentDDL</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/ddl/agentddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/agentddl.rb">lib/mcollective/ddl/agentddl.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">Base</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="#M000266">::new</a></li>
+
+ <li><a href="#M000271">#action</a></li>
+
+ <li><a href="#M000276">#action_interface</a></li>
+
+ <li><a href="#M000277">#actions</a></li>
+
+ <li><a href="#M000269">#aggregate</a></li>
+
+ <li><a href="#M000270">#display</a></li>
+
+ <li><a href="#M000267">#input</a></li>
+
+ <li><a href="#M000273">#is_function?</a></li>
+
+ <li><a href="#M000272">#method_missing</a></li>
+
+ <li><a href="#M000274">#set_default_input_arguments</a></li>
+
+ <li><a href="#M000268">#summarize</a></li>
+
+ <li><a href="#M000275">#validate_rpc_request</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::DDL::AgentDDL</h1>
+
+ <div id="description">
+ <p>
+A <a href="../DDL.html">DDL</a> class specific to agent plugins.
+</p>
+<p>
+A full <a href="../DDL.html">DDL</a> can be seen below with all the
+possible bells and whistles present.
+</p>
+<p>
+metadata :name => “Utilities and Helpers for SimpleRPC Agents”,
+</p>
+<pre>
+ :description => "General helpful actions that expose stats and internals to SimpleRPC clients",
+ :author => "R.I.Pienaar <rip@devco.net>",
+ :license => "Apache License, Version 2.0",
+ :version => "1.0",
+ :url => "http://marionette-collective.org/",
+ :timeout => 10
+</pre>
+<p>
+action “get_fact“, :description => “Retrieve a single
+fact from the fact store” do
+</p>
+<pre>
+ display :always
+
+ input :fact,
+ :prompt => "The name of the fact",
+ :description => "The fact to retrieve",
+ :type => :string,
+ :validation => '^[\w\-\.]+$',
+ :optional => false,
+ :maxlength => 40,
+ :default => "fqdn"
+
+ output :fact,
+ :description => "The name of the fact being returned",
+ :display_as => "Fact"
+
+ output :value,
+ :description => "The value of the fact",
+ :display_as => "Value",
+ :default => ""
+
+ summarize do
+ aggregate summary(:value)
+ end
+</pre>
+<p>
+end
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- 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="M000266"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(plugin, plugintype=:agent, loadddl=true)</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/ddl/agentddl.rb, line 41</span>
+41: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">plugin</span>, <span class="ruby-identifier">plugintype</span>=<span class="ruby-identifier">:agent</span>, <span class="ruby-identifier">loadddl</span>=<span class="ruby-keyword kw">true</span>)
+42: <span class="ruby-ivar">@process_aggregate_functions</span> = <span class="ruby-keyword kw">nil</span>
+43:
+44: <span class="ruby-keyword kw">super</span>
+45: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="action-method" class="method-detail ">
+ <a name="M000271"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">action</span><span
+ class="method-args">(name, input, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates the definition for an action, you can nest input definitions inside
+the action to attach inputs and validation to the actions
+</p>
+<pre>
+ action "status", :description => "Restarts a Service" do
+ display :always
+
+ input "service",
+ :prompt => "Service Action",
+ :description => "The action to perform",
+ :type => :list,
+ :optional => true,
+ :list => ["start", "stop", "restart", "status"]
+
+ output "status",
+ :description => "The status of the service after the action"
+
+ end
+</pre>
+
+
+
+ <div class="method-source-code"
+ id="action-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 112</span>
+112: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">action</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">input</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+113: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Action needs a :description property"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:description</span>)
+114:
+115: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@entities</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">name</span>)
+116: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>] = {}
+117: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:action</span>] = <span class="ruby-identifier">name</span>
+118: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:input</span>] = {}
+119: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:output</span>] = {}
+120: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:display</span>] = <span class="ruby-identifier">:failed</span>
+121: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:description</span>] = <span class="ruby-identifier">input</span>[<span class="ruby-identifier">:description</span>]
+122: <span class="ruby-keyword kw">end</span>
+123:
+124: <span class="ruby-comment cmt"># if a block is passed it might be creating input methods, call it</span>
+125: <span class="ruby-comment cmt"># we set @current_entity so the input block can know what its talking</span>
+126: <span class="ruby-comment cmt"># to, this is probably an epic hack, need to improve.</span>
+127: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-identifier">name</span>
+128: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+129: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-keyword kw">nil</span>
+130: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="action-interface-method" class="method-detail ">
+ <a name="M000276"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">action_interface</span><span
+ class="method-args">(name)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns the interface for a specific action
+</p>
+
+
+
+ <div class="method-source-code"
+ id="action-interface-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 198</span>
+198: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">action_interface</span>(<span class="ruby-identifier">name</span>)
+199: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>] <span class="ruby-operator">||</span> {}
+200: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="actions-method" class="method-detail ">
+ <a name="M000277"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">actions</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns an array of actions this agent support
+</p>
+
+
+
+ <div class="method-source-code"
+ id="actions-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 203</span>
+203: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">actions</span>
+204: <span class="ruby-ivar">@entities</span>.<span class="ruby-identifier">keys</span>
+205: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="aggregate-method" class="method-detail ">
+ <a name="M000269"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">aggregate</span><span
+ class="method-args">(function, format = {:format => nil})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sets the aggregate array for the given action
+</p>
+
+
+
+ <div class="method-source-code"
+ id="aggregate-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 70</span>
+70: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">aggregate</span>(<span class="ruby-identifier">function</span>, <span class="ruby-identifier">format</span> = {<span class="ruby-identifier">:format</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>})
+71: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC28</span>, <span class="ruby-value str">"Formats supplied to aggregation functions should be a hash"</span>, <span class="ruby-identifier">:error</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">format</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
+72: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC27</span>, <span class="ruby-value str">"Formats supplied to aggregation functions must have a :format key"</span>, <span class="ruby-identifier">:error</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">format</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:format</span>)
+73: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC26</span>, <span class="ruby-value str">"Functions supplied to aggregate should be a hash"</span>, <span class="ruby-identifier">:error</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">function</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
+74:
+75: <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">function</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:args</span>)) <span class="ruby-operator">&&</span> <span class="ruby-identifier">function</span>[<span class="ruby-identifier">:args</span>]
+76: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC25</span>, <span class="ruby-value str">"aggregate method for action '%{action}' missing a function parameter"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">entities</span>[<span class="ruby-ivar">@current_entity</span>][<span class="ruby-identifier">:action</span>])
+77: <span class="ruby-keyword kw">end</span>
+78:
+79: <span class="ruby-identifier">entities</span>[<span class="ruby-ivar">@current_entity</span>][<span class="ruby-identifier">:aggregate</span>] <span class="ruby-operator">||=</span> []
+80: <span class="ruby-identifier">entities</span>[<span class="ruby-ivar">@current_entity</span>][<span class="ruby-identifier">:aggregate</span>] <span class="ruby-operator"><<</span> (<span class="ruby-identifier">format</span>[<span class="ruby-identifier">:format</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-value">? </span><span class="ruby-identifier">function</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">function</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">format</span>))
+81: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="display-method" class="method-detail ">
+ <a name="M000270"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">display</span><span
+ class="method-args">(pref)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sets the display preference to either :ok, :failed, :flatten or :always
+operates on action level
+</p>
+
+
+
+ <div class="method-source-code"
+ id="display-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 85</span>
+85: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">display</span>(<span class="ruby-identifier">pref</span>)
+86: <span class="ruby-comment cmt"># defaults to old behavior, complain if its supplied and invalid</span>
+87: <span class="ruby-keyword kw">unless</span> [<span class="ruby-identifier">:ok</span>, <span class="ruby-identifier">:failed</span>, <span class="ruby-identifier">:flatten</span>, <span class="ruby-identifier">:always</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">pref</span>)
+88: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Display preference #{pref} is not valid, should be :ok, :failed, :flatten or :always"</span>
+89: <span class="ruby-keyword kw">end</span>
+90:
+91: <span class="ruby-identifier">action</span> = <span class="ruby-ivar">@current_entity</span>
+92: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">action</span>][<span class="ruby-identifier">:display</span>] = <span class="ruby-identifier">pref</span>
+93: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="input-method" class="method-detail ">
+ <a name="M000267"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">input</span><span
+ class="method-args">(argument, properties)</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="input-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 47</span>
+47: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">input</span>(<span class="ruby-identifier">argument</span>, <span class="ruby-identifier">properties</span>)
+48: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Input needs a :optional property"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">properties</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:optional</span>)
+49:
+50: <span class="ruby-keyword kw">super</span>
+51: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="is-function--method" class="method-detail ">
+ <a name="M000273"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">is_function?</span><span
+ class="method-args">(method_name)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Checks if a method name matches a aggregate plugin. This is used by method
+missing so that we dont greedily assume that every <a
+href="AgentDDL.html#M000272">method_missing</a> call in an agent ddl has
+hit a aggregate function.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="is-function--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 146</span>
+146: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">is_function?</span>(<span class="ruby-identifier">method_name</span>)
+147: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find</span>(<span class="ruby-value str">"aggregate"</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">method_name</span>.<span class="ruby-identifier">to_s</span>)
+148: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="method-missing-method" class="method-detail ">
+ <a name="M000272"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">method_missing</span><span
+ class="method-args">(name, *args, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+If the method name matches a # aggregate function, we return the function
+with args as a hash. This will only be active if the
+@process_aggregate_functions is set to true which only happens in the <a
+href="AgentDDL.html#M000268">summarize</a> block
+</p>
+
+
+
+ <div class="method-source-code"
+ id="method-missing-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 135</span>
+135: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+136: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@process_aggregate_functions</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">is_function?</span>(<span class="ruby-identifier">name</span>)
+137: <span class="ruby-identifier">raise</span> <span class="ruby-constant">NoMethodError</span>, <span class="ruby-node">"undefined local variable or method `#{name}'"</span>, <span class="ruby-identifier">caller</span>
+138: <span class="ruby-keyword kw">end</span>
+139:
+140: <span class="ruby-keyword kw">return</span> {<span class="ruby-identifier">:function</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">:args</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">args</span>}
+141: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="set-default-input-arguments-method" class="method-detail ">
+ <a name="M000274"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">set_default_input_arguments</span><span
+ class="method-args">(action, arguments)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+For a given action and arguments look up the <a href="../DDL.html">DDL</a>
+interface to that action and if any arguments in the <a
+href="../DDL.html">DDL</a> have a :default value assign that to any input
+that does not have an argument in the input arguments
+</p>
+<p>
+This is intended to only be called on clients and not on servers as the
+clients should never be able to publish non compliant requests and the
+servers should really not tamper with incoming requests since doing so
+might raise validation errors that were not raised on the client breaking
+our fail-fast approach to input validation
+</p>
+
+
+
+ <div class="method-source-code"
+ id="set-default-input-arguments-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 159</span>
+159: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_default_input_arguments</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">arguments</span>)
+160: <span class="ruby-identifier">input</span> = <span class="ruby-identifier">action_interface</span>(<span class="ruby-identifier">action</span>)[<span class="ruby-identifier">:input</span>]
+161:
+162: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>
+163:
+164: <span class="ruby-identifier">input</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
+165: <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:default</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:optional</span>]
+166: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Setting default value for input '%s' to '%s'"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">key</span>, <span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:default</span>]])
+167: <span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:default</span>]
+168: <span class="ruby-keyword kw">end</span>
+169: <span class="ruby-keyword kw">end</span>
+170: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="summarize-method" class="method-detail ">
+ <a name="M000268"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">summarize</span><span
+ class="method-args">(&block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Calls the summarize block defined in the ddl. Block will not be called if
+the ddl is getting processed on the server side. This means that aggregate
+plugins only have to be present on the client side.
+</p>
+<p>
+The @process_aggregate_functions variable is used by the <a
+href="AgentDDL.html#M000272">method_missing</a> block to determine if it
+should kick in, this way we very tightly control where we activate the <a
+href="AgentDDL.html#M000272">method_missing</a> behavior turning it into a
+noop otherwise to maximise the chance of providing good user feedback
+</p>
+
+
+
+ <div class="method-source-code"
+ id="summarize-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 61</span>
+61: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">summarize</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+62: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">mode</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:server</span>
+63: <span class="ruby-ivar">@process_aggregate_functions</span> = <span class="ruby-keyword kw">true</span>
+64: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>
+65: <span class="ruby-ivar">@process_aggregate_functions</span> = <span class="ruby-keyword kw">nil</span>
+66: <span class="ruby-keyword kw">end</span>
+67: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-rpc-request-method" class="method-detail ">
+ <a name="M000275"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate_rpc_request</span><span
+ class="method-args">(action, arguments)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Helper to use the <a href="../DDL.html">DDL</a> to figure out if the remote
+call to an agent should be allowed based on action name and inputs.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="validate-rpc-request-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 174</span>
+174: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_rpc_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">arguments</span>)
+175: <span class="ruby-comment cmt"># is the action known?</span>
+176: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">actions</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">action</span>)
+177: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC29</span>, <span class="ruby-value str">"Attempted to call action %{action} for %{plugin} but it's not declared in the DDL"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">action</span>, <span class="ruby-identifier">:plugin</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@pluginname</span>)
+178: <span class="ruby-keyword kw">end</span>
+179:
+180: <span class="ruby-identifier">input</span> = <span class="ruby-identifier">action_interface</span>(<span class="ruby-identifier">action</span>)[<span class="ruby-identifier">:input</span>] <span class="ruby-operator">||</span> {}
+181:
+182: <span class="ruby-identifier">input</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
+183: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:optional</span>]
+184: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
+185: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC30</span>, <span class="ruby-value str">"Action '%{action}' needs a '%{key}' argument"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">action</span>, <span class="ruby-identifier">:key</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>)
+186: <span class="ruby-keyword kw">end</span>
+187: <span class="ruby-keyword kw">end</span>
+188:
+189: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
+190: <span class="ruby-identifier">validate_input_argument</span>(<span class="ruby-identifier">input</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">key</span>])
+191: <span class="ruby-keyword kw">end</span>
+192: <span class="ruby-keyword kw">end</span>
+193:
+194: <span class="ruby-keyword kw">true</span>
+195: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+ <div id="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>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>Class: MCollective::DDL::Base</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::DDL::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/ddl/base_rb.html">
- lib/mcollective/ddl/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+ <title>Class: MCollective::DDL::Base</title>
+ <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
- <div id="contextContent">
+ <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>
- <div id="description">
- <p>
+</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/ddl/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/base.rb">lib/mcollective/ddl/base.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="#M000278">::new</a></li>
+
+ <li><a href="#M000283">#findddlfile</a></li>
+
+ <li><a href="#M000279">#help</a></li>
+
+ <li><a href="#M000288">#input</a></li>
+
+ <li><a href="#M000282">#loadddlfile</a></li>
+
+ <li><a href="#M000292">#metadata</a></li>
+
+ <li><a href="#M000290">#output</a></li>
+
+ <li><a href="#M000291">#requires</a></li>
+
+ <li><a href="#M000281">#template_for_plugintype</a></li>
+
+ <li><a href="#M000280">#usage</a></li>
+
+ <li><a href="#M000285">#validate_input_argument</a></li>
+
+ <li><a href="#M000284">#validate_requirements</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ <div id="includes-section" class="section">
+ <h3 class="section-header">Included Modules</h3>
+ <ul class="link-list">
+
+
+ <li><a class="include" href="../Validator.html">MCollective::Validator</a></li>
+
+
+ </ul>
+ </div>
+
+ </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::DDL::Base</h1>
+
+ <div id="description">
+ <p>
The base class for all kinds of <a href="../DDL.html">DDL</a> files. <a
href="../DDL.html">DDL</a> files when run gets parsed and builds up a hash
of the basic primitive types, ideally restricted so it can be converted to
</p>
<p>
The Hash being built should be stored in @entities, the format is generally
-not prescribed but there̵
6;s a definite feel to how <a
+not prescribed but there̵
7;s a definite feel to how <a
href="../DDL.html">DDL</a> files look so study the agent and discovery ones
to see how the structure applies to very different use cases.
</p>
<p>
For every plugin type you should have a single word name - that corresponds
to the directory in the libdir where these plugins live. If you need
-anything above and beyond ‘<a
-href="Base.html#M000177">metadata</a>’ in your plugin <a
+anything above and beyond ‘metadata’ in your plugin <a
href="../DDL.html">DDL</a> then add a PlugintypeDDL class here and add your
specific behaviors to those.
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000171">findddlfile</a>
- <a href="#M000167">help</a>
- <a href="#M000174">input</a>
- <a href="#M000170">loadddlfile</a>
- <a href="#M000177">metadata</a>
- <a href="#M000166">new</a>
- <a href="#M000175">output</a>
- <a href="#M000176">requires</a>
- <a href="#M000169">template_for_plugintype</a>
- <a href="#M000168">usage</a>
- <a href="#M000173">validate_input_argument</a>
- <a href="#M000172">validate_requirements</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
- <div id="includes">
- <h3 class="section-bar">Included Modules</h3>
-
- <div id="includes-list">
- <span class="include-name"><a href="../Translatable.html">Translatable</a></span>
- </div>
- </div>
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">entities</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">meta</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">pluginname</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">plugintype</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">requirements</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">usage</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000166" class="method-detail">
- <a name="M000166"></a>
-
- <div class="method-heading">
- <a href="#M000166" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(plugin, plugintype=:agent, loadddl=true)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000166-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000166-source">
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="meta-attribute-method" class="method-detail">
+ <a name="meta"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">meta</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="entities-attribute-method" class="method-detail">
+ <a name="entities"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">entities</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="pluginname-attribute-method" class="method-detail">
+ <a name="pluginname"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">pluginname</span><span
+ class="attribute-access-type">[R]</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>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">plugintype</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="usage-attribute-method" class="method-detail">
+ <a name="usage"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">usage</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="requirements-attribute-method" class="method-detail">
+ <a name="requirements"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">requirements</span><span
+ class="attribute-access-type">[R]</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="M000278"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(plugin, plugintype=:agent, loadddl=true)</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/ddl/base.rb, line 24</span>
24: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">plugin</span>, <span class="ruby-identifier">plugintype</span>=<span class="ruby-identifier">:agent</span>, <span class="ruby-identifier">loadddl</span>=<span class="ruby-keyword kw">true</span>)
31: <span class="ruby-ivar">@requirements</span> = {}
32:
33: <span class="ruby-identifier">loadddlfile</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">loadddl</span>
-34: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000171" class="method-detail">
- <a name="M000171"></a>
-
- <div class="method-heading">
- <a href="#M000171" class="method-signature">
- <span class="method-name">findddlfile</span><span class="method-args">(ddlname=nil, ddltype=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000171-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000171-source">
+34: <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="findddlfile-method" class="method-detail ">
+ <a name="M000283"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">findddlfile</span><span
+ class="method-args">(ddlname=nil, ddltype=nil)</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="findddlfile-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ddl/base.rb, line 89</span>
89: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">findddlfile</span>(<span class="ruby-identifier">ddlname</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">ddltype</span>=<span class="ruby-keyword kw">nil</span>)
98: <span class="ruby-keyword kw">end</span>
99: <span class="ruby-keyword kw">end</span>
100: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
-101: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000167" class="method-detail">
- <a name="M000167"></a>
-
- <div class="method-heading">
- <a href="#M000167" class="method-signature">
- <span class="method-name">help</span><span class="method-args">(template=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Generates <a href="Base.html#M000167">help</a> using the template based on
-the data created with <a href="Base.html#M000177">metadata</a> and <a
-href="Base.html#M000174">input</a>.
+101: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="help-method" class="method-detail ">
+ <a name="M000279"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">help</span><span
+ class="method-args">(template=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Generates help using the template based on the data created with metadata
+and input.
</p>
<p>
If no template name is provided one will be chosen based on the plugin
be loaded either from the config dir and if that does not exist, default to
/etc/mcollective
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000167-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000167-source">
+
+
+
+ <div class="method-source-code"
+ id="help-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ddl/base.rb, line 44</span>
44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">help</span>(<span class="ruby-identifier">template</span>=<span class="ruby-keyword kw">nil</span>)
58:
59: <span class="ruby-identifier">erb</span> = <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">template</span>, <span class="ruby-value">0</span>, <span class="ruby-value str">'%'</span>)
60: <span class="ruby-identifier">erb</span>.<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>)
-61: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000174" class="method-detail">
- <a name="M000174"></a>
-
- <div class="method-heading">
- <a href="#M000174" class="method-signature">
- <span class="method-name">input</span><span class="method-args">(argument, properties)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Registers an <a href="Base.html#M000174">input</a> argument for a given
-action
+61: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="input-method" class="method-detail ">
+ <a name="M000288"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">input</span><span
+ class="method-args">(argument, properties)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Registers an input argument for a given action
</p>
<p>
See the documentation for action for how to use this
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000174-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000174-source">
+
+
+
+ <div class="method-source-code"
+ id="input-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ddl/base.rb, line 153</span>
153: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">input</span>(<span class="ruby-identifier">argument</span>, <span class="ruby-identifier">properties</span>)
178:
179: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">entity</span>][<span class="ruby-identifier">:input</span>][<span class="ruby-identifier">argument</span>][<span class="ruby-identifier">:list</span>] = <span class="ruby-identifier">properties</span>[<span class="ruby-identifier">:list</span>]
180: <span class="ruby-keyword kw">end</span>
-181: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000170" class="method-detail">
- <a name="M000170"></a>
-
- <div class="method-heading">
- <a href="#M000170" class="method-signature">
- <span class="method-name">loadddlfile</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000170-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000170-source">
+181: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="loadddlfile-method" class="method-detail ">
+ <a name="M000282"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">loadddlfile</span><span
+ class="method-args">()</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="loadddlfile-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ddl/base.rb, line 81</span>
81: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">loadddlfile</span>
84: <span class="ruby-keyword kw">else</span>
85: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC40</span>, <span class="ruby-value str">"Can't find DDL for %{type} plugin '%{name}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@plugintype</span>, <span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@pluginname</span>)
86: <span class="ruby-keyword kw">end</span>
-87: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000177" class="method-detail">
- <a name="M000177"></a>
-
- <div class="method-heading">
- <a href="#M000177" class="method-signature">
- <span class="method-name">metadata</span><span class="method-args">(meta)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+87: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="metadata-method" class="method-detail ">
+ <a name="M000292"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">metadata</span><span
+ class="method-args">(meta)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Registers meta data for the introspection hash
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000177-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000177-source">
+
+
+
+ <div class="method-source-code"
+ id="metadata-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ddl/base.rb, line 215</span>
215: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">metadata</span>(<span class="ruby-identifier">meta</span>)
218: <span class="ruby-keyword kw">end</span>
219:
220: <span class="ruby-ivar">@meta</span> = <span class="ruby-identifier">meta</span>
-221: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000175" class="method-detail">
- <a name="M000175"></a>
-
- <div class="method-heading">
- <a href="#M000175" class="method-signature">
- <span class="method-name">output</span><span class="method-args">(argument, properties)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Registers an <a href="Base.html#M000175">output</a> argument for a given
-action
+221: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="output-method" class="method-detail ">
+ <a name="M000290"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">output</span><span
+ class="method-args">(argument, properties)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Registers an output argument for a given action
</p>
<p>
See the documentation for action for how to use this
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000175-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000175-source">
+
+
+
+ <div class="method-source-code"
+ id="output-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ddl/base.rb, line 186</span>
186: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">output</span>(<span class="ruby-identifier">argument</span>, <span class="ruby-identifier">properties</span>)
193: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">action</span>][<span class="ruby-identifier">:output</span>][<span class="ruby-identifier">argument</span>] = {<span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">properties</span>[<span class="ruby-identifier">:description</span>],
194: <span class="ruby-identifier">:display_as</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">properties</span>[<span class="ruby-identifier">:display_as</span>],
195: <span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">properties</span>[<span class="ruby-identifier">:default</span>]}
-196: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000176" class="method-detail">
- <a name="M000176"></a>
-
- <div class="method-heading">
- <a href="#M000176" class="method-signature">
- <span class="method-name">requires</span><span class="method-args">(requirement)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000176-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000176-source">
+196: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="requires-method" class="method-detail ">
+ <a name="M000291"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">requires</span><span
+ class="method-args">(requirement)</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="requires-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ddl/base.rb, line 198</span>
198: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">requires</span>(<span class="ruby-identifier">requirement</span>)
209: <span class="ruby-keyword kw">end</span>
210:
211: <span class="ruby-identifier">validate_requirements</span>
-212: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000169" class="method-detail">
- <a name="M000169"></a>
-
- <div class="method-heading">
- <a href="#M000169" class="method-signature">
- <span class="method-name">template_for_plugintype</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000169-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000169-source">
+212: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="template-for-plugintype-method" class="method-detail ">
+ <a name="M000281"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">template_for_plugintype</span><span
+ class="method-args">()</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="template-for-plugintype-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ddl/base.rb, line 67</span>
67: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">template_for_plugintype</span>
76: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"metadata-help.erb"</span>
77: <span class="ruby-keyword kw">end</span>
78: <span class="ruby-keyword kw">end</span>
-79: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000168" class="method-detail">
- <a name="M000168"></a>
-
- <div class="method-heading">
- <a href="#M000168" class="method-signature">
- <span class="method-name">usage</span><span class="method-args">(usage_text)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000168-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000168-source">
+79: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="usage-method" class="method-detail ">
+ <a name="M000280"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">usage</span><span
+ class="method-args">(usage_text)</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="usage-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ddl/base.rb, line 63</span>
63: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">usage</span>(<span class="ruby-identifier">usage_text</span>)
64: <span class="ruby-ivar">@usage</span> = <span class="ruby-identifier">usage_text</span>
-65: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000173" class="method-detail">
- <a name="M000173"></a>
-
- <div class="method-heading">
- <a href="#M000173" class="method-signature">
- <span class="method-name">validate_input_argument</span><span class="method-args">(input, key, argument)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-validate strings, lists and booleans, we‘ll add more types of
+65: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-input-argument-method" class="method-detail ">
+ <a name="M000285"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate_input_argument</span><span
+ class="method-args">(input, key, argument)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+validate strings, lists and booleans, we’ll add more types of
validators when all the use cases are clear
</p>
<p>
:string can have maxlength and regex. A maxlength of 0 will bypasss checks
:list has a array of valid values
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000173-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000173-source">
+
+
+
+ <div class="method-source-code"
+ id="validate-input-argument-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ddl/base.rb, line 127</span>
127: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_input_argument</span>(<span class="ruby-identifier">input</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">argument</span>)
145: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
146: <span class="ruby-keyword kw">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
147: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC21</span>, <span class="ruby-value str">"Cannot validate input '%{input}': %{error}"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:input</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>)
-148: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000172" class="method-detail">
- <a name="M000172"></a>
-
- <div class="method-heading">
- <a href="#M000172" class="method-signature">
- <span class="method-name">validate_requirements</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000172-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000172-source">
+148: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-requirements-method" class="method-detail ">
+ <a name="M000284"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate_requirements</span><span
+ class="method-args">()</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="validate-requirements-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ddl/base.rb, line 103</span>
103: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_requirements</span>
113: <span class="ruby-keyword kw">end</span>
114:
115: <span class="ruby-keyword kw">true</span>
-116: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+116: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </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>
-</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>
\ No newline at end of file
+</html>
+
--- /dev/null
+<?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::DDL::DataDDL</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/ddl/dataddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/dataddl.rb">lib/mcollective/ddl/dataddl.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">Base</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="#M000286">#dataquery</a></li>
+
+ <li><a href="#M000289">#dataquery_interface</a></li>
+
+ <li><a href="#M000287">#input</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::DDL::DataDDL</h1>
+
+ <div id="description">
+ <p>
+A <a href="../DDL.html">DDL</a> file for the data query plugins.
+</p>
+<p>
+Query plugins can today take only one input by convention in the <a
+href="../DDL.html">DDL</a> that is called :query, otherwise the input is
+identical to the standard input.
+</p>
+<p>
+metadata :name => “Agent”,
+</p>
+<pre>
+ :description => "Meta data about installed MColletive Agents",
+ :author => "R.I.Pienaar <rip@devco.net>",
+ :license => "ASL 2.0",
+ :version => "1.0",
+ :url => "http://marionette-collective.org/",
+ :timeout => 1
+</pre>
+<p>
+dataquery :description => “<a href="../Agent.html">Agent</a> Meta
+Data” do
+</p>
+<pre>
+ input :query,
+ :prompt => "Agent Name",
+ :description => "Valid agent name",
+ :type => :string,
+ :validation => /^[\w\_]+$/,
+ :maxlength => 20
+
+ [:license, :timeout, :description, :url, :version, :author].each do |item|
+ output item,
+ :description => "Agent #{item}",
+ :display_as => item.to_s.capitalize
+ end
+</pre>
+<p>
+end
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="dataquery-method" class="method-detail ">
+ <a name="M000286"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">dataquery</span><span
+ class="method-args">(input, &block)</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="dataquery-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 31</span>
+31: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dataquery</span>(<span class="ruby-identifier">input</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+32: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Data queries need a :description"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:description</span>)
+33: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Data queries can only have one definition"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>]
+34:
+35: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>] = {<span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">input</span>[<span class="ruby-identifier">:description</span>],
+36: <span class="ruby-identifier">:input</span> =<span class="ruby-operator">></span> {},
+37: <span class="ruby-identifier">:output</span> =<span class="ruby-operator">></span> {}}
+38:
+39: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-identifier">:data</span>
+40: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+41: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-keyword kw">nil</span>
+42: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="dataquery-interface-method" class="method-detail ">
+ <a name="M000289"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">dataquery_interface</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns the interface for the data query
+</p>
+
+
+
+ <div class="method-source-code"
+ id="dataquery-interface-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 51</span>
+51: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dataquery_interface</span>
+52: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>] <span class="ruby-operator">||</span> {}
+53: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="input-method" class="method-detail ">
+ <a name="M000287"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">input</span><span
+ class="method-args">(argument, properties)</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="input-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 44</span>
+44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">input</span>(<span class="ruby-identifier">argument</span>, <span class="ruby-identifier">properties</span>)
+45: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"The only valid input name for a data query is 'query'"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">argument</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">:query</span>
+46:
+47: <span class="ruby-keyword kw">super</span>
+48: <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>
+
--- /dev/null
+<?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::DDL::DiscoveryDDL</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/ddl/discoveryddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/discoveryddl.rb">lib/mcollective/ddl/discoveryddl.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">Base</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="#M000258">#capabilities</a></li>
+
+ <li><a href="#M000262">#discovery</a></li>
+
+ <li><a href="#M000257">#discovery_interface</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::DDL::DiscoveryDDL</h1>
+
+ <div id="description">
+ <p>
+<a href="../DDL.html">DDL</a> for discovery plugins, a full example can be
+seen below
+</p>
+<p>
+metadata :name => “mc”,
+</p>
+<pre>
+ :description => "MCollective Broadcast based discovery",
+ :author => "R.I.Pienaar <rip@devco.net>",
+ :license => "ASL 2.0",
+ :version => "0.1",
+ :url => "http://marionette-collective.org/",
+ :timeout => 2
+</pre>
+<p>
+discovery do
+</p>
+<pre>
+ capabilities [:classes, :facts, :identity, :agents, :compound]
+</pre>
+<p>
+end
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="capabilities-method" class="method-detail ">
+ <a name="M000258"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">capabilities</span><span
+ class="method-args">(*caps)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+records valid capabilities for discovery plugins
+</p>
+
+
+
+ <div class="method-source-code"
+ id="capabilities-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/discoveryddl.rb, line 22</span>
+22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">capabilities</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">caps</span>)
+23: <span class="ruby-identifier">caps</span> = [<span class="ruby-identifier">caps</span>].<span class="ruby-identifier">flatten</span>
+24:
+25: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Discovery plugin capabilities can't be empty"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">caps</span>.<span class="ruby-identifier">empty?</span>
+26:
+27: <span class="ruby-identifier">caps</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">cap</span><span class="ruby-operator">|</span>
+28: <span class="ruby-keyword kw">if</span> [<span class="ruby-identifier">:classes</span>, <span class="ruby-identifier">:facts</span>, <span class="ruby-identifier">:identity</span>, <span class="ruby-identifier">:agents</span>, <span class="ruby-identifier">:compound</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">cap</span>)
+29: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:discovery</span>][<span class="ruby-identifier">:capabilities</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">cap</span>
+30: <span class="ruby-keyword kw">else</span>
+31: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"%s is not a valid capability, valid capabilities are :classes, :facts, :identity, :agents and :compound"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">cap</span>
+32: <span class="ruby-keyword kw">end</span>
+33: <span class="ruby-keyword kw">end</span>
+34: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-method" class="method-detail ">
+ <a name="M000262"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery</span><span
+ class="method-args">(&block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates the definition for new discovery plugins
+</p>
+<pre>
+ discovery do
+ capabilities [:classes, :facts, :identity, :agents, :compound]
+ end
+</pre>
+
+
+
+ <div class="method-source-code"
+ id="discovery-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/discoveryddl.rb, line 41</span>
+41: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+42: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Discovery plugins can only have one definition"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:discovery</span>]
+43:
+44: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:discovery</span>] = {<span class="ruby-identifier">:capabilities</span> =<span class="ruby-operator">></span> []}
+45:
+46: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-identifier">:discovery</span>
+47: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+48: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-keyword kw">nil</span>
+49: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-interface-method" class="method-detail ">
+ <a name="M000257"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery_interface</span><span
+ class="method-args">()</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="discovery-interface-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/discoveryddl.rb, line 17</span>
+17: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_interface</span>
+18: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:discovery</span>]
+19: <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>
+
--- /dev/null
+<?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::DDL::ValidatorDDL</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/ddl/validatorddl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ddl/validatorddl.rb">lib/mcollective/ddl/validatorddl.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">Base</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::DDL::ValidatorDDL</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::DDLValidationError</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">CodedError</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::DDLValidationError</h1>
+
+ <div id="description">
+ <p>
+Exceptions for the <a href="RPC.html">RPC</a> system
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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>Module: MCollective::Data</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="module">
+
+ <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/data/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/data/base.rb">lib/mcollective/data/base.rb</a></li>
+
+ <li><a href="../lib/mcollective/data/result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/data/result.rb">lib/mcollective/data/result.rb</a></li>
+
+ <li><a href="../lib/mcollective/data_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/data.rb">lib/mcollective/data.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="Data/Base.html">MCollective::Data::Base</a></li>
+
+ <li><span class="type">CLASS</span> <a href="Data/Result.html">MCollective::Data::Result</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000488">::[]</a></li>
+
+ <li><a href="#M000490">::ddl</a></li>
+
+ <li><a href="#M000492">::ddl_has_output?</a></li>
+
+ <li><a href="#M000493">::ddl_transform_input</a></li>
+
+ <li><a href="#M000491">::ddl_validate</a></li>
+
+ <li><a href="#M000486">::load_data_sources</a></li>
+
+ <li><a href="#M000489">::method_missing</a></li>
+
+ <li><a href="#M000487">::pluginname</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="module">MCollective::Data</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000488"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(plugin)</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="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 26</span>
+26: <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>)
+27: <span class="ruby-constant">PluginManager</span>[<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">plugin</span>)]
+28: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="ddl-method" class="method-detail ">
+ <a name="M000490"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">ddl</span><span
+ class="method-args">(plugin)</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="ddl-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 37</span>
+37: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ddl</span>(<span class="ruby-identifier">plugin</span>)
+38: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">plugin</span>), <span class="ruby-identifier">:data</span>)
+39: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="ddl-has-output--method" class="method-detail ">
+ <a name="M000492"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">ddl_has_output?</span><span
+ class="method-args">(ddl, output)</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="ddl-has-output--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 62</span>
+62: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ddl_has_output?</span>(<span class="ruby-identifier">ddl</span>, <span class="ruby-identifier">output</span>)
+63: <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">entities</span>[<span class="ruby-identifier">:data</span>][<span class="ruby-identifier">:output</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">output</span>.<span class="ruby-identifier">to_sym</span>) <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">false</span>
+64: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="ddl-transform-input-method" class="method-detail ">
+ <a name="M000493"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">ddl_transform_input</span><span
+ class="method-args">(ddl, input)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+For an input where the <a href="DDL.html">DDL</a> requests a boolean or
+some number this will convert the input to the right type where possible
+else just returns the origin input unedited
+</p>
+<p>
+if anything here goes wrong just return the input value this is not really
+the end of the world or anything since all that will happen is that <a
+href="DDL.html">DDL</a> validation will fail and the user will get an
+error, no need to be too defensive here
+</p>
+
+
+
+ <div class="method-source-code"
+ id="ddl-transform-input-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 74</span>
+74: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ddl_transform_input</span>(<span class="ruby-identifier">ddl</span>, <span class="ruby-identifier">input</span>)
+75: <span class="ruby-keyword kw">begin</span>
+76: <span class="ruby-identifier">type</span> = <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">entities</span>[<span class="ruby-identifier">:data</span>][<span class="ruby-identifier">:input</span>][<span class="ruby-identifier">:query</span>][<span class="ruby-identifier">:type</span>]
+77:
+78: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">type</span>
+79: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:boolean</span>
+80: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">string_to_boolean</span>(<span class="ruby-identifier">input</span>)
+81:
+82: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:number</span>, <span class="ruby-identifier">:integer</span>, <span class="ruby-identifier">:float</span>
+83: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">string_to_number</span>(<span class="ruby-identifier">input</span>)
+84: <span class="ruby-keyword kw">end</span>
+85: <span class="ruby-keyword kw">rescue</span>
+86: <span class="ruby-keyword kw">end</span>
+87:
+88: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">input</span>
+89: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="ddl-validate-method" class="method-detail ">
+ <a name="M000491"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">ddl_validate</span><span
+ class="method-args">(ddl, argument)</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="ddl-validate-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 41</span>
+41: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ddl_validate</span>(<span class="ruby-identifier">ddl</span>, <span class="ruby-identifier">argument</span>)
+42: <span class="ruby-identifier">name</span> = <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:name</span>]
+43: <span class="ruby-identifier">query</span> = <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">entities</span>[<span class="ruby-identifier">:data</span>]
+44:
+45: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC31</span>, <span class="ruby-value str">"No dataquery has been defined in the DDL for data plugin '%{plugin}'"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:plugin</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">query</span>
+46:
+47: <span class="ruby-identifier">input</span> = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:input</span>, {})
+48: <span class="ruby-identifier">output</span> = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:output</span>, {})
+49:
+50: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC32</span>, <span class="ruby-value str">"No output has been defined in the DDL for data plugin %{plugin}"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:plugin</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">output</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">empty?</span>
+51:
+52: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">input</span>[<span class="ruby-identifier">:query</span>]
+53: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">argument</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">input</span>[<span class="ruby-identifier">:query</span>][<span class="ruby-identifier">:optional</span>]
+54:
+55: <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">validate_input_argument</span>(<span class="ruby-identifier">input</span>, <span class="ruby-identifier">:query</span>, <span class="ruby-identifier">argument</span>)
+56: <span class="ruby-keyword kw">else</span>
+57: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC33</span>, <span class="ruby-value str">"No data plugin argument was declared in the '%{plugin}' DDL but an input was supplied"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:plugin</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">argument</span>
+58: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+59: <span class="ruby-keyword kw">end</span>
+60: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="load-data-sources-method" class="method-detail ">
+ <a name="M000486"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_data_sources</span><span
+ class="method-args">()</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="load-data-sources-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 6</span>
+ 6: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_data_sources</span>
+ 7: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find_and_load</span>(<span class="ruby-value str">"data"</span>)
+ 8:
+ 9: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-regexp re">/_data$/</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">plugin</span><span class="ruby-operator">|</span>
+10: <span class="ruby-keyword kw">begin</span>
+11: <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">PluginManager</span>[<span class="ruby-identifier">plugin</span>].<span class="ruby-identifier">class</span>.<span class="ruby-identifier">activate?</span>
+12: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Disabling data plugin %s due to plugin activation policy"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">plugin</span>)
+13: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">plugin</span>)
+14: <span class="ruby-keyword kw">end</span>
+15: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+16: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Disabling data plugin %s due to exception #{e.class}: #{e}"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">plugin</span>)
+17: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">plugin</span>)
+18: <span class="ruby-keyword kw">end</span>
+19: <span class="ruby-keyword kw">end</span>
+20: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="method-missing-method" class="method-detail ">
+ <a name="M000489"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">method_missing</span><span
+ class="method-args">(method, *args)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Data.package(“httpd”).architecture
+</p>
+
+
+
+ <div class="method-source-code"
+ id="method-missing-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 31</span>
+31: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+32: <span class="ruby-keyword kw">super</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">method</span>))
+33:
+34: <span class="ruby-constant">PluginManager</span>[<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">method</span>)].<span class="ruby-identifier">lookup</span>(<span class="ruby-identifier">args</span>.<span class="ruby-identifier">first</span>)
+35: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="pluginname-method" class="method-detail ">
+ <a name="M000487"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">pluginname</span><span
+ class="method-args">(plugin)</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="pluginname-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 22</span>
+22: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">plugin</span>)
+23: <span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/_data$/i</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">:</span> <span class="ruby-value str">"%s_data"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span>
+24: <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>
+
--- /dev/null
+<?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::Data::Base</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/data/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/data/base.rb">lib/mcollective/data/base.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="#M000196">::activate?</a></li>
+
+ <li><a href="#M000189">::activate_when</a></li>
+
+ <li><a href="#M000184">::inherited</a></li>
+
+ <li><a href="#M000185">::new</a></li>
+
+ <li><a href="#M000187">::query</a></li>
+
+ <li><a href="#M000188">#ddl_validate</a></li>
+
+ <li><a href="#M000186">#lookup</a></li>
+
+ <li><a href="#M000197">#startup_hook</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::Data::Base</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="name-attribute-method" class="method-detail">
+ <a name="name"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">name</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="result-attribute-method" class="method-detail">
+ <a name="result"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">result</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ddl-attribute-method" class="method-detail">
+ <a name="ddl"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ddl</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="timeout-attribute-method" class="method-detail">
+ <a name="timeout"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">timeout</span><span
+ class="attribute-access-type">[R]</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="activate--method" class="method-detail ">
+ <a name="M000196"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">activate?</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Always be active unless a specific block is given with <a
+href="Base.html#M000189">activate_when</a>
+</p>
+
+
+
+ <div class="method-source-code"
+ id="activate--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 60</span>
+60: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">activate?</span>
+61: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+62: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="activate-when-method" class="method-detail ">
+ <a name="M000189"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">activate_when</span><span
+ class="method-args">(&block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+<a href="Base.html#M000189">activate_when</a> do
+</p>
+<pre>
+ file.exist?("/usr/bin/puppet")
+</pre>
+<p>
+end
+</p>
+
+
+
+ <div class="method-source-code"
+ id="activate-when-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 53</span>
+53: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">activate_when</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+54: (<span class="ruby-keyword kw">class</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">self</span>; <span class="ruby-keyword kw">self</span>; <span class="ruby-keyword kw">end</span>).<span class="ruby-identifier">instance_eval</span> <span class="ruby-keyword kw">do</span>
+55: <span class="ruby-identifier">define_method</span>(<span class="ruby-value str">"activate?"</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+56: <span class="ruby-keyword kw">end</span>
+57: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="inherited-method" class="method-detail ">
+ <a name="M000184"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">inherited</span><span
+ class="method-args">(klass)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Register plugins that inherits base
+</p>
+
+
+
+ <div class="method-source-code"
+ id="inherited-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 7</span>
+ 7: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
+ 8: <span class="ruby-identifier">type</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"::"</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
+ 9:
+10: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">:single_instance</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>}
+11: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="new-method" class="method-detail ">
+ <a name="M000185"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">()</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/data/base.rb, line 13</span>
+13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+14: <span class="ruby-ivar">@name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"::"</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
+15: <span class="ruby-ivar">@ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@name</span>, <span class="ruby-identifier">:data</span>)
+16: <span class="ruby-ivar">@result</span> = <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">dataquery_interface</span>[<span class="ruby-identifier">:output</span>])
+17: <span class="ruby-ivar">@timeout</span> = <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:timeout</span>] <span class="ruby-operator">||</span> <span class="ruby-value">1</span>
+18:
+19: <span class="ruby-identifier">startup_hook</span>
+20: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="query-method" class="method-detail ">
+ <a name="M000187"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">query</span><span
+ class="method-args">(&block)</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="query-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 42</span>
+42: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">query</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+43: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">module_eval</span> { <span class="ruby-identifier">define_method</span>(<span class="ruby-value str">"query_data"</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) }
+44: <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="ddl-validate-method" class="method-detail ">
+ <a name="M000188"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">ddl_validate</span><span
+ class="method-args">(what)</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="ddl-validate-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 46</span>
+46: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ddl_validate</span>(<span class="ruby-identifier">what</span>)
+47: <span class="ruby-constant">Data</span>.<span class="ruby-identifier">ddl_validate</span>(<span class="ruby-ivar">@ddl</span>, <span class="ruby-identifier">what</span>)
+48: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="lookup-method" class="method-detail ">
+ <a name="M000186"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">lookup</span><span
+ class="method-args">(what)</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="lookup-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 22</span>
+22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lookup</span>(<span class="ruby-identifier">what</span>)
+23: <span class="ruby-identifier">ddl_validate</span>(<span class="ruby-identifier">what</span>)
+24:
+25: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Doing data query %s for '%s'"</span> <span class="ruby-operator">%</span> [ <span class="ruby-ivar">@name</span>, <span class="ruby-identifier">what</span> ])
+26:
+27: <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-identifier">timeout</span>(<span class="ruby-ivar">@timeout</span>) <span class="ruby-keyword kw">do</span>
+28: <span class="ruby-identifier">query_data</span>(<span class="ruby-identifier">what</span>)
+29: <span class="ruby-keyword kw">end</span>
+30:
+31: <span class="ruby-ivar">@result</span>
+32: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>
+33: <span class="ruby-comment cmt"># Timeout::Error is a inherited from Interrupt which seems a really</span>
+34: <span class="ruby-comment cmt"># strange choice, making it an equivelant of ^C and such. Catch it</span>
+35: <span class="ruby-comment cmt"># and raise something less critical that will not the runner to just</span>
+36: <span class="ruby-comment cmt"># give up the ghost</span>
+37: <span class="ruby-identifier">msg</span> = <span class="ruby-value str">"Data plugin %s timed out on query '%s'"</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@name</span>, <span class="ruby-identifier">what</span>]
+38: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">msg</span>)
+39: <span class="ruby-identifier">raise</span> <span class="ruby-constant">MsgTTLExpired</span>, <span class="ruby-identifier">msg</span>
+40: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="startup-hook-method" class="method-detail ">
+ <a name="M000197"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">startup_hook</span><span
+ class="method-args">()</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="startup-hook-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 64</span>
+64: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">startup_hook</span>;<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>
+
--- /dev/null
+<?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::Data::Result</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/data/result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/data/result.rb">lib/mcollective/data/result.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="#M000190">::new</a></li>
+
+ <li><a href="#M000192">#[]</a></li>
+
+ <li><a href="#M000193">#[]=</a></li>
+
+ <li><a href="#M000191">#include?</a></li>
+
+ <li><a href="#M000194">#keys</a></li>
+
+ <li><a href="#M000195">#method_missing</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::Data::Result</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- 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="M000190"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(outputs)</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/data/result.rb, line 9</span>
+ 9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">outputs</span>)
+10: <span class="ruby-ivar">@data</span> = {}
+11:
+12: <span class="ruby-identifier">outputs</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span><span class="ruby-operator">|</span>
+13: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">output</span>] = <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">outputs</span>[<span class="ruby-identifier">output</span>].<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:default</span>, <span class="ruby-keyword kw">nil</span>)))
+14: <span class="ruby-keyword kw">end</span>
+15: <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="--method" class="method-detail ">
+ <a name="M000192"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(key)</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="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 21</span>
+21: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
+22: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>]
+23: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000193"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]=</span><span
+ class="method-args">(key, val)</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="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 25</span>
+25: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span>)
+26: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Can only store String, Integer, Float or Boolean data but got #{val.class} for key #{key}"</span> <span class="ruby-keyword kw">unless</span> [<span class="ruby-constant">String</span>, <span class="ruby-constant">Fixnum</span>, <span class="ruby-constant">Bignum</span>, <span class="ruby-constant">Float</span>, <span class="ruby-constant">TrueClass</span>, <span class="ruby-constant">FalseClass</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">val</span>.<span class="ruby-identifier">class</span>)
+27:
+28: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">val</span>
+29: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="include--method" class="method-detail ">
+ <a name="M000191"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">include?</span><span
+ class="method-args">(key)</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="include--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 17</span>
+17: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
+18: <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>)
+19: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="keys-method" class="method-detail ">
+ <a name="M000194"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">keys</span><span
+ class="method-args">()</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="keys-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 31</span>
+31: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">keys</span>
+32: <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">keys</span>
+33: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="method-missing-method" class="method-detail ">
+ <a name="M000195"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">method_missing</span><span
+ class="method-args">(method, *args)</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="method-missing-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 35</span>
+35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+36: <span class="ruby-identifier">key</span> = <span class="ruby-identifier">method</span>.<span class="ruby-identifier">to_sym</span>
+37:
+38: <span class="ruby-identifier">raise</span> <span class="ruby-constant">NoMethodError</span>, <span class="ruby-value str">"undefined local variable or method `%s'"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">key</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
+39:
+40: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>]
+41: <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>
+
--- /dev/null
+<?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::Discovery</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/discovery_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/discovery.rb">lib/mcollective/discovery.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="#M000141">::new</a></li>
+
+ <li><a href="#M000148">#check_capabilities</a></li>
+
+ <li><a href="#M000147">#ddl</a></li>
+
+ <li><a href="#M000156">#discover</a></li>
+
+ <li><a href="#M000146">#discovery_class</a></li>
+
+ <li><a href="#M000145">#discovery_method</a></li>
+
+ <li><a href="#M000155">#discovery_timeout</a></li>
+
+ <li><a href="#M000142">#find_known_methods</a></li>
+
+ <li><a href="#M000144">#force_direct_mode?</a></li>
+
+ <li><a href="#M000149">#force_discovery_method_by_filter</a></li>
+
+ <li><a href="#M000143">#has_method?</a></li>
+
+ <li><a href="#M000150">#timeout_for_compound_filter</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::Discovery</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- 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="M000141"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(client)</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/discovery.rb, line 3</span>
+3: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">client</span>)
+4: <span class="ruby-ivar">@known_methods</span> = <span class="ruby-identifier">find_known_methods</span>
+5: <span class="ruby-ivar">@default_method</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">default_discovery_method</span>
+6: <span class="ruby-ivar">@client</span> = <span class="ruby-identifier">client</span>
+7: <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="check-capabilities-method" class="method-detail ">
+ <a name="M000148"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">check_capabilities</span><span
+ class="method-args">(filter)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+<a href="Agent.html">Agent</a> filters are always present no matter what,
+so we cant raise an error if the capabilities suggest the discovery method
+cant do agents we just have to rely on the discovery plugin to not do
+stupid things in the presense of a agent filter
+</p>
+
+
+
+ <div class="method-source-code"
+ id="check-capabilities-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 62</span>
+62: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check_capabilities</span>(<span class="ruby-identifier">filter</span>)
+63: <span class="ruby-identifier">capabilities</span> = <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">discovery_interface</span>[<span class="ruby-identifier">:capabilities</span>]
+64:
+65: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">capabilities</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:classes</span>)
+66: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Cannot use class filters while using the '%s' discovery method"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">discovery_method</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"cf_class"</span>].<span class="ruby-identifier">empty?</span>
+67: <span class="ruby-keyword kw">end</span>
+68:
+69: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">capabilities</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:facts</span>)
+70: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Cannot use fact filters while using the '%s' discovery method"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">discovery_method</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"fact"</span>].<span class="ruby-identifier">empty?</span>
+71: <span class="ruby-keyword kw">end</span>
+72:
+73: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">capabilities</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:identity</span>)
+74: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Cannot use identity filters while using the '%s' discovery method"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">discovery_method</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"identity"</span>].<span class="ruby-identifier">empty?</span>
+75: <span class="ruby-keyword kw">end</span>
+76:
+77: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">capabilities</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:compound</span>)
+78: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Cannot use compound filters while using the '%s' discovery method"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">discovery_method</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"compound"</span>].<span class="ruby-identifier">empty?</span>
+79: <span class="ruby-keyword kw">end</span>
+80: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="ddl-method" class="method-detail ">
+ <a name="M000147"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">ddl</span><span
+ class="method-args">()</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="ddl-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 47</span>
+47: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ddl</span>
+48: <span class="ruby-ivar">@ddl</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">discovery_method</span>, <span class="ruby-identifier">:discovery</span>)
+49:
+50: <span class="ruby-comment cmt"># if the discovery method got changed we might have an old DDL cached</span>
+51: <span class="ruby-comment cmt"># this will detect that and reread the correct DDL from disk</span>
+52: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:name</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">discovery_method</span>
+53: <span class="ruby-ivar">@ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">discovery_method</span>, <span class="ruby-identifier">:discovery</span>)
+54: <span class="ruby-keyword kw">end</span>
+55:
+56: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@ddl</span>
+57: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discover-method" class="method-detail ">
+ <a name="M000156"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discover</span><span
+ class="method-args">(filter, timeout, limit)</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="discover-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 127</span>
+127: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discover</span>(<span class="ruby-identifier">filter</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">limit</span>)
+128: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Limit has to be an integer"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">limit</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Fixnum</span>)
+129:
+130: <span class="ruby-identifier">force_discovery_method_by_filter</span>(<span class="ruby-identifier">filter</span>)
+131:
+132: <span class="ruby-identifier">check_capabilities</span>(<span class="ruby-identifier">filter</span>)
+133:
+134: <span class="ruby-identifier">discovered</span> = <span class="ruby-identifier">discovery_class</span>.<span class="ruby-identifier">discover</span>(<span class="ruby-identifier">filter</span>, <span class="ruby-identifier">discovery_timeout</span>(<span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">filter</span>), <span class="ruby-identifier">limit</span>, <span class="ruby-ivar">@client</span>)
+135:
+136: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">limit</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
+137: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">discovered</span>[<span class="ruby-value">0</span>,<span class="ruby-identifier">limit</span>]
+138: <span class="ruby-keyword kw">else</span>
+139: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">discovered</span>
+140: <span class="ruby-keyword kw">end</span>
+141: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-class-method" class="method-detail ">
+ <a name="M000146"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery_class</span><span
+ class="method-args">()</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="discovery-class-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 39</span>
+39: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_class</span>
+40: <span class="ruby-identifier">method</span> = <span class="ruby-identifier">discovery_method</span>.<span class="ruby-identifier">capitalize</span>
+41:
+42: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"MCollective::Discovery::#{method}"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-identifier">method</span>)
+43:
+44: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">method</span>)
+45: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-method-method" class="method-detail ">
+ <a name="M000145"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery_method</span><span
+ class="method-args">()</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="discovery-method-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 21</span>
+21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_method</span>
+22: <span class="ruby-identifier">method</span> = <span class="ruby-value str">"mc"</span>
+23:
+24: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:discovery_method</span>]
+25: <span class="ruby-identifier">method</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:discovery_method</span>]
+26: <span class="ruby-keyword kw">else</span>
+27: <span class="ruby-identifier">method</span> = <span class="ruby-ivar">@default_method</span>
+28: <span class="ruby-keyword kw">end</span>
+29:
+30: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Unknown discovery method %s"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">method</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">has_method?</span>(<span class="ruby-identifier">method</span>)
+31:
+32: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">method</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"mc"</span>
+33: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Custom discovery methods require direct addressing mode"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">direct_addressing</span>
+34: <span class="ruby-keyword kw">end</span>
+35:
+36: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">method</span>
+37: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-timeout-method" class="method-detail ">
+ <a name="M000155"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery_timeout</span><span
+ class="method-args">(timeout, filter)</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="discovery-timeout-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 117</span>
+117: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_timeout</span>(<span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">filter</span>)
+118: <span class="ruby-identifier">timeout</span> = <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:timeout</span>] <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">timeout</span>
+119:
+120: <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">filter</span>[<span class="ruby-value str">"compound"</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"compound"</span>].<span class="ruby-identifier">empty?</span>)
+121: <span class="ruby-identifier">timeout</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">timeout_for_compound_filter</span>(<span class="ruby-identifier">filter</span>[<span class="ruby-value str">"compound"</span>])
+122: <span class="ruby-keyword kw">else</span>
+123: <span class="ruby-identifier">timeout</span>
+124: <span class="ruby-keyword kw">end</span>
+125: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="find-known-methods-method" class="method-detail ">
+ <a name="M000142"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">find_known_methods</span><span
+ class="method-args">()</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="find-known-methods-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 9</span>
+ 9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">find_known_methods</span>
+10: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find</span>(<span class="ruby-value str">"discovery"</span>)
+11: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="force-direct-mode--method" class="method-detail ">
+ <a name="M000144"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">force_direct_mode?</span><span
+ class="method-args">()</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="force-direct-mode--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 17</span>
+17: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">force_direct_mode?</span>
+18: <span class="ruby-identifier">discovery_method</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">"mc"</span>
+19: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="force-discovery-method-by-filter-method" class="method-detail ">
+ <a name="M000149"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">force_discovery_method_by_filter</span><span
+ class="method-args">(filter)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+checks if compound filters are used and then forces the ‘mc’
+discovery plugin
+</p>
+
+
+
+ <div class="method-source-code"
+ id="force-discovery-method-by-filter-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 83</span>
+83: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">force_discovery_method_by_filter</span>(<span class="ruby-identifier">filter</span>)
+84: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">discovery_method</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"mc"</span>
+85: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"compound"</span>].<span class="ruby-identifier">empty?</span>
+86: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">"Switching to mc discovery method because compound filters are used"</span>
+87: <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:discovery_method</span>] = <span class="ruby-value str">"mc"</span>
+88:
+89: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+90: <span class="ruby-keyword kw">end</span>
+91: <span class="ruby-keyword kw">end</span>
+92:
+93: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+94: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-method--method" class="method-detail ">
+ <a name="M000143"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_method?</span><span
+ class="method-args">(method)</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="has-method--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 13</span>
+13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_method?</span>(<span class="ruby-identifier">method</span>)
+14: <span class="ruby-ivar">@known_methods</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">method</span>)
+15: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="timeout-for-compound-filter-method" class="method-detail ">
+ <a name="M000150"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">timeout_for_compound_filter</span><span
+ class="method-args">(compound_filter)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+if a compound filter is specified and it has any function then we read the
+<a href="DDL.html">DDL</a> for each of those plugins and sum up the timeout
+declared in the <a href="DDL.html">DDL</a>
+</p>
+
+
+
+ <div class="method-source-code"
+ id="timeout-for-compound-filter-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 99</span>
+ 99: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">timeout_for_compound_filter</span>(<span class="ruby-identifier">compound_filter</span>)
+100: <span class="ruby-keyword kw">return</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">compound_filter</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">compound_filter</span>.<span class="ruby-identifier">empty?</span>
+101:
+102: <span class="ruby-identifier">timeout</span> = <span class="ruby-value">0</span>
+103:
+104: <span class="ruby-identifier">compound_filter</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">filter</span><span class="ruby-operator">|</span>
+105: <span class="ruby-identifier">filter</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">statement</span><span class="ruby-operator">|</span>
+106: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>]
+107: <span class="ruby-identifier">pluginname</span> = <span class="ruby-constant">Data</span>.<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>][<span class="ruby-value str">"name"</span>])
+108: <span class="ruby-identifier">ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pluginname</span>, <span class="ruby-identifier">:data</span>)
+109: <span class="ruby-identifier">timeout</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:timeout</span>]
+110: <span class="ruby-keyword kw">end</span>
+111: <span class="ruby-keyword kw">end</span>
+112: <span class="ruby-keyword kw">end</span>
+113:
+114: <span class="ruby-identifier">timeout</span>
+115: <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>
+
--- /dev/null
+<?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>Module: MCollective::Facts</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="module">
+
+ <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/facts/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/facts/base.rb">lib/mcollective/facts/base.rb</a></li>
+
+ <li><a href="../lib/mcollective/facts_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/facts.rb">lib/mcollective/facts.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="Facts/Base.html">MCollective::Facts::Base</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000484">::[]</a></li>
+
+ <li><a href="#M000483">::get_fact</a></li>
+
+ <li><a href="#M000482">::has_fact?</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="module">MCollective::Facts</h1>
+
+ <div id="description">
+ <p>
+This is a class that gives access to the configured fact provider such as
+MCollectives::Facts::Facter that uses Reductive Labs facter
+</p>
+<p>
+The actual provider is pluggable and configurable using the
+‘factsource’ configuration option.
+</p>
+<p>
+To develop a new factsource simply create a class under
+MCollective::Facts:: and provide the following classes:
+</p>
+<pre>
+ self.get_fact(fact)
+ self.has_fact?(fact)
+</pre>
+<p>
+You can also just inherit from <a
+href="Facts/Base.html">MCollective::Facts::Base</a> and provide just the
+</p>
+<pre>
+ self.get_facts
+</pre>
+<p>
+method that should return a hash of facts.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000484"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(fact)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Get the value of a fact
+</p>
+
+
+
+ <div class="method-source-code"
+ id="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts.rb, line 35</span>
+35: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">fact</span>)
+36: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"facts_plugin"</span>].<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
+37: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="get-fact-method" class="method-detail ">
+ <a name="M000483"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">get_fact</span><span
+ class="method-args">(fact)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Get the value of a fact
+</p>
+
+
+
+ <div class="method-source-code"
+ id="get-fact-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts.rb, line 30</span>
+30: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
+31: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"facts_plugin"</span>].<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
+32: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-fact--method" class="method-detail ">
+ <a name="M000482"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_fact?</span><span
+ class="method-args">(fact, value)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+True if we know of a specific fact else false
+</p>
+
+
+
+ <div class="method-source-code"
+ id="has-fact--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts.rb, line 25</span>
+25: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_fact?</span>(<span class="ruby-identifier">fact</span>, <span class="ruby-identifier">value</span>)
+26: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"facts_plugin"</span>].<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>) <span class="ruby-operator">==</span> <span class="ruby-identifier">value</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">false</span>
+27: <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>
+
--- /dev/null
+<?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::Facts::Base</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/facts/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/facts/base.rb">lib/mcollective/facts/base.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="#M000260">::inherited</a></li>
+
+ <li><a href="#M000259">::new</a></li>
+
+ <li><a href="#M000265">#force_reload?</a></li>
+
+ <li><a href="#M000261">#get_fact</a></li>
+
+ <li><a href="#M000263">#get_facts</a></li>
+
+ <li><a href="#M000264">#has_fact?</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::Facts::Base</h1>
+
+ <div id="description">
+ <p>
+A base class for fact providers, to make a new fully functional fact
+provider inherit from this and simply provide a self.get_facts method that
+returns a hash like:
+</p>
+<pre>
+ {"foo" => "bar",
+ "bar" => "baz"}
+</pre>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="inherited-method" class="method-detail ">
+ <a name="M000260"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">inherited</span><span
+ class="method-args">(klass)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Registers new fact sources into the plugin manager
+</p>
+
+
+
+ <div class="method-source-code"
+ id="inherited-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 17</span>
+17: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
+18: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"facts_plugin"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>}
+19: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="new-method" class="method-detail ">
+ <a name="M000259"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">()</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/facts/base.rb, line 10</span>
+10: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+11: <span class="ruby-ivar">@facts</span> = {}
+12: <span class="ruby-ivar">@last_good_facts</span> = {}
+13: <span class="ruby-ivar">@last_facts_load</span> = <span class="ruby-value">0</span>
+14: <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="force-reload--method" class="method-detail ">
+ <a name="M000265"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">force_reload?</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Plugins can override this to provide forced fact invalidation
+</p>
+
+
+
+ <div class="method-source-code"
+ id="force-reload--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 81</span>
+81: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">force_reload?</span>
+82: <span class="ruby-keyword kw">false</span>
+83: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="get-fact-method" class="method-detail ">
+ <a name="M000261"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">get_fact</span><span
+ class="method-args">(fact=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns the value of a single fact
+</p>
+
+
+
+ <div class="method-source-code"
+ id="get-fact-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 22</span>
+22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>=<span class="ruby-keyword kw">nil</span>)
+23: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
+24:
+25: <span class="ruby-identifier">cache_time</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">fact_cache_time</span> <span class="ruby-operator">||</span> <span class="ruby-value">300</span>
+26:
+27: <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">exclusive</span> <span class="ruby-keyword kw">do</span>
+28: <span class="ruby-keyword kw">begin</span>
+29: <span class="ruby-keyword kw">if</span> (<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@last_facts_load</span> <span class="ruby-operator">></span> <span class="ruby-identifier">cache_time</span>.<span class="ruby-identifier">to_i</span> ) <span class="ruby-operator">||</span> <span class="ruby-identifier">force_reload?</span>
+30: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Resetting facter cache, now: #{Time.now.to_i} last-known-good: #{@last_facts_load}"</span>)
+31:
+32: <span class="ruby-identifier">tfacts</span> = <span class="ruby-identifier">load_facts_from_source</span>
+33:
+34: <span class="ruby-comment cmt"># Force reset to last known good state on empty facts</span>
+35: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Got empty facts"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">tfacts</span>.<span class="ruby-identifier">empty?</span>
+36:
+37: <span class="ruby-ivar">@facts</span>.<span class="ruby-identifier">clear</span>
+38:
+39: <span class="ruby-identifier">tfacts</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>,<span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
+40: <span class="ruby-ivar">@facts</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">to_s</span>
+41: <span class="ruby-keyword kw">end</span>
+42:
+43: <span class="ruby-ivar">@last_good_facts</span> = <span class="ruby-ivar">@facts</span>.<span class="ruby-identifier">clone</span>
+44: <span class="ruby-ivar">@last_facts_load</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>
+45: <span class="ruby-keyword kw">else</span>
+46: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Using cached facts now: #{Time.now.to_i} last-known-good: #{@last_facts_load}"</span>)
+47: <span class="ruby-keyword kw">end</span>
+48: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+49: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Failed to load facts: #{e.class}: #{e}"</span>)
+50:
+51: <span class="ruby-comment cmt"># Avoid loops where failing fact loads cause huge CPU</span>
+52: <span class="ruby-comment cmt"># loops, this way it only retries once every cache_time</span>
+53: <span class="ruby-comment cmt"># seconds</span>
+54: <span class="ruby-ivar">@last_facts_load</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>
+55:
+56: <span class="ruby-comment cmt"># Revert to last known good state</span>
+57: <span class="ruby-ivar">@facts</span> = <span class="ruby-ivar">@last_good_facts</span>.<span class="ruby-identifier">clone</span>
+58: <span class="ruby-keyword kw">end</span>
+59: <span class="ruby-keyword kw">end</span>
+60:
+61:
+62: <span class="ruby-comment cmt"># If you do not supply a specific fact all facts will be returned</span>
+63: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">fact</span>.<span class="ruby-identifier">nil?</span>
+64: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@facts</span>
+65: <span class="ruby-keyword kw">else</span>
+66: <span class="ruby-ivar">@facts</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">fact</span>) <span class="ruby-operator">?</span> <span class="ruby-ivar">@facts</span>[<span class="ruby-identifier">fact</span>] <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>
+67: <span class="ruby-keyword kw">end</span>
+68: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="get-facts-method" class="method-detail ">
+ <a name="M000263"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">get_facts</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns all facts
+</p>
+
+
+
+ <div class="method-source-code"
+ id="get-facts-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 71</span>
+71: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_facts</span>
+72: <span class="ruby-identifier">get_fact</span>(<span class="ruby-keyword kw">nil</span>)
+73: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-fact--method" class="method-detail ">
+ <a name="M000264"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_fact?</span><span
+ class="method-args">(fact)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns true if we know about a specific fact, false otherwise
+</p>
+
+
+
+ <div class="method-source-code"
+ id="has-fact--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 76</span>
+76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_fact?</span>(<span class="ruby-identifier">fact</span>)
+77: <span class="ruby-identifier">get_fact</span>(<span class="ruby-keyword kw">nil</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">fact</span>)
+78: <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>
+
--- /dev/null
+<?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>Module: MCollective::Generators</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="module">
+
+ <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/generators/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/generators/base.rb">lib/mcollective/generators/base.rb</a></li>
+
+ <li><a href="../lib/mcollective/generators/data_generator_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/generators/data_generator.rb">lib/mcollective/generators/data_generator.rb</a></li>
+
+ <li><a href="../lib/mcollective/generators/agent_generator_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/generators/agent_generator.rb">lib/mcollective/generators/agent_generator.rb</a></li>
+
+ <li><a href="../lib/mcollective/generators_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/generators.rb">lib/mcollective/generators.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
+
+ <li><span class="type">CLASS</span> <a href="Generators/Base.html">MCollective::Generators::Base</a></li>
+
+ <li><span class="type">CLASS</span> <a href="Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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="module">MCollective::Generators</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::Generators::AgentGenerator</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/generators/agent_generator_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/generators/agent_generator.rb">lib/mcollective/generators/agent_generator.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">Base</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="#M000245">::new</a></li>
+
+ <li><a href="#M000248">#action_help</a></li>
+
+ <li><a href="#M000246">#create_ddl</a></li>
+
+ <li><a href="#M000247">#create_plugin_content</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::Generators::AgentGenerator</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="ddl-attribute-method" class="method-detail">
+ <a name="ddl"></a>
+
+ <a name="ddl="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ddl</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="content-attribute-method" class="method-detail">
+ <a name="content"></a>
+
+ <a name="content="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">content</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="M000245"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(plugin_name, actions = [], name = nil, description = nil, author = nil , license = nil, version = nil, url = nil, timeout = nil)</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/generators/agent_generator.rb, line 7</span>
+ 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">plugin_name</span>, <span class="ruby-identifier">actions</span> = [], <span class="ruby-identifier">name</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">description</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">author</span> = <span class="ruby-keyword kw">nil</span> ,
+ 8: <span class="ruby-identifier">license</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">version</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">url</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">timeout</span> = <span class="ruby-keyword kw">nil</span>)
+ 9:
+10: <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">description</span>, <span class="ruby-identifier">author</span>, <span class="ruby-identifier">license</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">timeout</span>)
+11: <span class="ruby-ivar">@plugin_name</span> = <span class="ruby-identifier">plugin_name</span>
+12: <span class="ruby-ivar">@actions</span> = <span class="ruby-identifier">actions</span> <span class="ruby-operator">||</span> []
+13: <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">create_ddl</span>
+14: <span class="ruby-ivar">@mod_name</span> = <span class="ruby-value str">"Agent"</span>
+15: <span class="ruby-ivar">@pclass</span> = <span class="ruby-value str">"RPC::Agent"</span>
+16: <span class="ruby-ivar">@content</span> = <span class="ruby-identifier">create_plugin_content</span>
+17: <span class="ruby-ivar">@plugin</span> = <span class="ruby-identifier">create_plugin_string</span>
+18: <span class="ruby-identifier">write_plugins</span>
+19: <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="action-help-method" class="method-detail ">
+ <a name="M000248"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">action_help</span><span
+ class="method-args">()</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="action-help-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/generators/agent_generator.rb, line 45</span>
+45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">action_help</span>
+46: <span class="ruby-identifier">action_snippet</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">"templates"</span>, <span class="ruby-value str">"action_snippet.erb"</span>))
+47: <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">action_snippet</span>).<span class="ruby-identifier">result</span>
+48: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="create-ddl-method" class="method-detail ">
+ <a name="M000246"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">create_ddl</span><span
+ class="method-args">()</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="create-ddl-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/generators/agent_generator.rb, line 21</span>
+21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_ddl</span>
+22: <span class="ruby-identifier">action_text</span> = <span class="ruby-value str">""</span>
+23: <span class="ruby-ivar">@actions</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">action</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
+24: <span class="ruby-identifier">action_text</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"action \"#{action}\", :description => \"%ACTIONDESCRIPTION%\" do\n"</span>
+25: <span class="ruby-identifier">action_text</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">action_help</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+26: <span class="ruby-identifier">action_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"end\n"</span>
+27: <span class="ruby-identifier">action_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@actions</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> (<span class="ruby-identifier">i</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
+28: <span class="ruby-keyword kw">end</span>
+29: <span class="ruby-comment cmt"># Use inherited method to create metadata part of the ddl</span>
+30: <span class="ruby-identifier">create_metadata_string</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">action_text</span>
+31: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="create-plugin-content-method" class="method-detail ">
+ <a name="M000247"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">create_plugin_content</span><span
+ class="method-args">()</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="create-plugin-content-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/generators/agent_generator.rb, line 33</span>
+33: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_plugin_content</span>
+34: <span class="ruby-identifier">content_text</span> = <span class="ruby-value str">""</span>
+35:
+36: <span class="ruby-comment cmt"># Add actions to agent file</span>
+37: <span class="ruby-ivar">@actions</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">action</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
+38: <span class="ruby-identifier">content_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%6s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-node">"action \"#{action}\" do\n"</span>]
+39: <span class="ruby-identifier">content_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%6s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-value str">"end\n"</span>]
+40: <span class="ruby-identifier">content_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@actions</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> (<span class="ruby-identifier">i</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
+41: <span class="ruby-keyword kw">end</span>
+42: <span class="ruby-identifier">content_text</span>
+43: <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>
+
--- /dev/null
+<?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::Generators::Base</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/generators/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/generators/base.rb">lib/mcollective/generators/base.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="#M000238">::new</a></li>
+
+ <li><a href="#M000239">#create_metadata_string</a></li>
+
+ <li><a href="#M000240">#create_plugin_string</a></li>
+
+ <li><a href="#M000241">#write_plugins</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::Generators::Base</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="meta-attribute-method" class="method-detail">
+ <a name="meta"></a>
+
+ <a name="meta="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">meta</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="plugin-name-attribute-method" class="method-detail">
+ <a name="plugin_name"></a>
+
+ <a name="plugin_name="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">plugin_name</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="mod-name-attribute-method" class="method-detail">
+ <a name="mod_name"></a>
+
+ <a name="mod_name="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">mod_name</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="M000238"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(name, description, author, license, version, url, timeout)</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/generators/base.rb, line 5</span>
+ 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">description</span>, <span class="ruby-identifier">author</span>, <span class="ruby-identifier">license</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">timeout</span>)
+ 6: <span class="ruby-ivar">@meta</span> = {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>,
+ 7: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">description</span>,
+ 8: <span class="ruby-identifier">:author</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">author</span>,
+ 9: <span class="ruby-identifier">:license</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">license</span>,
+10: <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">version</span>,
+11: <span class="ruby-identifier">:url</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">url</span>,
+12: <span class="ruby-identifier">:timeout</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">timeout</span>}
+13: <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="create-metadata-string-method" class="method-detail ">
+ <a name="M000239"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">create_metadata_string</span><span
+ class="method-args">()</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="create-metadata-string-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 15</span>
+15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_metadata_string</span>
+16: <span class="ruby-identifier">ddl_template</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">"templates"</span>, <span class="ruby-value str">"ddl.erb"</span>))
+17: <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">ddl_template</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-value str">"-"</span>).<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>)
+18: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="create-plugin-string-method" class="method-detail ">
+ <a name="M000240"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">create_plugin_string</span><span
+ class="method-args">()</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="create-plugin-string-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 20</span>
+20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_plugin_string</span>
+21: <span class="ruby-identifier">plugin_template</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">"templates"</span>, <span class="ruby-value str">"plugin.erb"</span>))
+22: <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">plugin_template</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-value str">"-"</span>).<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>)
+23: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="write-plugins-method" class="method-detail ">
+ <a name="M000241"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">write_plugins</span><span
+ class="method-args">()</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="write-plugins-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 25</span>
+25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write_plugins</span>
+26: <span class="ruby-keyword kw">begin</span>
+27: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span> <span class="ruby-ivar">@plugin_name</span>
+28: <span class="ruby-identifier">dirname</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@plugin_name</span>, <span class="ruby-ivar">@mod_name</span>.<span class="ruby-identifier">downcase</span>)
+29: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span> <span class="ruby-identifier">dirname</span>
+30: <span class="ruby-identifier">puts</span> <span class="ruby-node">"Created plugin directory : #{@plugin_name}"</span>
+31:
+32: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">dirname</span>, <span class="ruby-node">"#{@plugin_name}.ddl"</span>), <span class="ruby-value str">"w"</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@ddl</span>}
+33: <span class="ruby-identifier">puts</span> <span class="ruby-node">"Created DDL file : #{File.join(dirname, "#{@plugin_name}.ddl")}"</span>
+34:
+35: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">dirname</span>, <span class="ruby-node">"#{@plugin_name}.rb"</span>), <span class="ruby-value str">"w"</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@plugin</span>}
+36: <span class="ruby-identifier">puts</span> <span class="ruby-node">"Created #{@mod_name} file : #{File.join(dirname, "#{@plugin_name}.rb")}"</span>
+37: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EEXIST</span>
+38: <span class="ruby-identifier">raise</span> <span class="ruby-node">"cannot generate '#{@plugin_name}' : plugin directory already exists."</span>
+39: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+40: <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span>(<span class="ruby-ivar">@plugin_name</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-ivar">@plugin_name</span>)
+41: <span class="ruby-identifier">raise</span> <span class="ruby-node">"cannot generate plugin - #{e}"</span>
+42: <span class="ruby-keyword kw">end</span>
+43: <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>
+
--- /dev/null
+<?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::Generators::DataGenerator</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/generators/data_generator_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/generators/data_generator.rb">lib/mcollective/generators/data_generator.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">Base</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="#M000242">::new</a></li>
+
+ <li><a href="#M000243">#create_ddl</a></li>
+
+ <li><a href="#M000244">#create_plugin_content</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::Generators::DataGenerator</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="ddl-attribute-method" class="method-detail">
+ <a name="ddl"></a>
+
+ <a name="ddl="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ddl</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="content-attribute-method" class="method-detail">
+ <a name="content"></a>
+
+ <a name="content="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">content</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="M000242"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(plugin_name, outputs = [], name = nil, description = nil, author = nil , license = nil, version = nil, url = nil, timeout = nil)</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/generators/data_generator.rb, line 7</span>
+ 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">plugin_name</span>, <span class="ruby-identifier">outputs</span> = [], <span class="ruby-identifier">name</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">description</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">author</span> = <span class="ruby-keyword kw">nil</span> ,
+ 8: <span class="ruby-identifier">license</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">version</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">url</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">timeout</span> = <span class="ruby-keyword kw">nil</span>)
+ 9:
+10: <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">description</span>, <span class="ruby-identifier">author</span>, <span class="ruby-identifier">license</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">timeout</span>)
+11: <span class="ruby-ivar">@mod_name</span> = <span class="ruby-value str">"Data"</span>
+12: <span class="ruby-ivar">@pclass</span> = <span class="ruby-value str">"Base"</span>
+13: <span class="ruby-ivar">@plugin_name</span> = <span class="ruby-identifier">plugin_name</span>
+14: <span class="ruby-ivar">@outputs</span> = <span class="ruby-identifier">outputs</span>
+15: <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">create_ddl</span>
+16: <span class="ruby-ivar">@content</span> = <span class="ruby-identifier">create_plugin_content</span>
+17: <span class="ruby-ivar">@plugin</span> = <span class="ruby-identifier">create_plugin_string</span>
+18: <span class="ruby-identifier">write_plugins</span>
+19: <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="create-ddl-method" class="method-detail ">
+ <a name="M000243"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">create_ddl</span><span
+ class="method-args">()</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="create-ddl-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/generators/data_generator.rb, line 21</span>
+21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_ddl</span>
+22: <span class="ruby-identifier">query_text</span> = <span class="ruby-value str">"dataquery :description => \"Query information\" do\n"</span>
+23: <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">"templates"</span>, <span class="ruby-value str">"data_input_snippet.erb"</span>))).<span class="ruby-identifier">result</span>
+24:
+25: <span class="ruby-ivar">@outputs</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span>,<span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
+26: <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%2s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-node">"output :#{output},\n"</span>]
+27: <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%9s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-value str">":description => \"%DESCRIPTION%\",\n"</span>]
+28: <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%9s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-value str">":display_as => \"%DESCRIPTION%\"\n"</span>]
+29: <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@outputs</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> (<span class="ruby-identifier">i</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
+30: <span class="ruby-keyword kw">end</span>
+31:
+32: <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"end"</span>
+33:
+34: <span class="ruby-comment cmt"># Use inherited method to create metadata part of the ddl</span>
+35: <span class="ruby-identifier">create_metadata_string</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">query_text</span>
+36: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="create-plugin-content-method" class="method-detail ">
+ <a name="M000244"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">create_plugin_content</span><span
+ class="method-args">()</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="create-plugin-content-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/generators/data_generator.rb, line 38</span>
+38: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_plugin_content</span>
+39: <span class="ruby-identifier">content_text</span> = <span class="ruby-value str">"%6s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-value str">"query do |what|\n"</span>]
+40:
+41: <span class="ruby-ivar">@outputs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span><span class="ruby-operator">|</span>
+42: <span class="ruby-identifier">content_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%8s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-node">"result[:#{output}] = nil\n"</span>]
+43: <span class="ruby-keyword kw">end</span>
+44: <span class="ruby-identifier">content_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%6s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-value str">"end\n"</span>]
+45:
+46: <span class="ruby-comment cmt"># Add actions to agent file</span>
+47: <span class="ruby-identifier">content_text</span>
+48: <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>
+
--- /dev/null
+<?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::InvalidRPCData</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">RPCError</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::InvalidRPCData</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::Log</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/log_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/log.rb">lib/mcollective/log.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="#M000124">::check_level</a></li>
+
+ <li><a href="#M000123">::config_and_check_level</a></li>
+
+ <li><a href="#M000131">::configure</a></li>
+
+ <li><a href="#M000122">::cycle_level</a></li>
+
+ <li><a href="#M000118">::debug</a></li>
+
+ <li><a href="#M000120">::error</a></li>
+
+ <li><a href="#M000134">::execution_stack</a></li>
+
+ <li><a href="#M000119">::fatal</a></li>
+
+ <li><a href="#M000133">::from</a></li>
+
+ <li><a href="#M000116">::info</a></li>
+
+ <li><a href="#M000121">::instance</a></li>
+
+ <li><a href="#M000129">::log</a></li>
+
+ <li><a href="#M000127">::logexception</a></li>
+
+ <li><a href="#M000115">::logger</a></li>
+
+ <li><a href="#M000128">::logmsg</a></li>
+
+ <li><a href="#M000126">::message_for</a></li>
+
+ <li><a href="#M000130">::set_logger</a></li>
+
+ <li><a href="#M000132">::unconfigure</a></li>
+
+ <li><a href="#M000125">::valid_level?</a></li>
+
+ <li><a href="#M000117">::warn</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::Log</h1>
+
+ <div id="description">
+ <p>
+A simple class that allows logging at various levels.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+ <div id="constants-list" class="section">
+ <h3 class="section-header">Constants</h3>
+ <dl>
+
+ <dt><a name="VALID_LEVELS">VALID_LEVELS</a></dt>
+
+ <dd class="description missing-docs">(Not documented)</dd>
+
+
+ </dl>
+ </div>
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="check-level-method" class="method-detail ">
+ <a name="M000124"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">check_level</span><span
+ class="method-args">(level)</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="check-level-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 55</span>
+55: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check_level</span>(<span class="ruby-identifier">level</span>)
+56: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Unknown log level"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">valid_level?</span>(<span class="ruby-identifier">level</span>)
+57: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="config-and-check-level-method" class="method-detail ">
+ <a name="M000123"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">config_and_check_level</span><span
+ class="method-args">(level)</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="config-and-check-level-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 49</span>
+49: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">config_and_check_level</span>(<span class="ruby-identifier">level</span>)
+50: <span class="ruby-identifier">configure</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@configured</span>
+51: <span class="ruby-identifier">check_level</span>(<span class="ruby-identifier">level</span>)
+52: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">should_log?</span>(<span class="ruby-identifier">level</span>)
+53: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="configure-method" class="method-detail ">
+ <a name="M000131"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">configure</span><span
+ class="method-args">(logger=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+configures the logger class, if the config has not yet been loaded we
+default to the console logging class and do not set @configured so that
+future calls to the log method will keep attempting to configure the logger
+till we eventually get a logging preference from the config module
+</p>
+
+
+
+ <div class="method-source-code"
+ id="configure-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 130</span>
+130: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure</span>(<span class="ruby-identifier">logger</span>=<span class="ruby-keyword kw">nil</span>)
+131: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">logger</span>
+132: <span class="ruby-identifier">logger_type</span> = <span class="ruby-value str">"console"</span>
+133:
+134: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
+135:
+136: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">configured</span>
+137: <span class="ruby-identifier">logger_type</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">logger_type</span>
+138: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">true</span>
+139: <span class="ruby-keyword kw">end</span>
+140:
+141: <span class="ruby-identifier">require</span> <span class="ruby-value str">"mcollective/logger/%s_logger"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">logger_type</span>.<span class="ruby-identifier">downcase</span>
+142:
+143: <span class="ruby-identifier">logger_class</span> = <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">Logger</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-value str">"%s_logger"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">logger_type</span>.<span class="ruby-identifier">capitalize</span>)
+144:
+145: <span class="ruby-identifier">set_logger</span>(<span class="ruby-identifier">logger_class</span>.<span class="ruby-identifier">new</span>)
+146: <span class="ruby-keyword kw">else</span>
+147: <span class="ruby-identifier">set_logger</span>(<span class="ruby-identifier">logger</span>)
+148: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">true</span>
+149: <span class="ruby-keyword kw">end</span>
+150:
+151:
+152: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">start</span>
+153: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+154: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">false</span>
+155: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Could not start logger: #{e.class} #{e}"</span>
+156: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="cycle-level-method" class="method-detail ">
+ <a name="M000122"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">cycle_level</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+increments the active log level
+</p>
+
+
+
+ <div class="method-source-code"
+ id="cycle-level-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 45</span>
+45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cycle_level</span>
+46: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">cycle_level</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@configured</span>
+47: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="debug-method" class="method-detail ">
+ <a name="M000118"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">debug</span><span
+ class="method-args">(msg)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Logs at debug level
+</p>
+
+
+
+ <div class="method-source-code"
+ id="debug-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 25</span>
+25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">debug</span>(<span class="ruby-identifier">msg</span>)
+26: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">msg</span>)
+27: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="error-method" class="method-detail ">
+ <a name="M000120"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">error</span><span
+ class="method-args">(msg)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Logs at error level
+</p>
+
+
+
+ <div class="method-source-code"
+ id="error-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 35</span>
+35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">error</span>(<span class="ruby-identifier">msg</span>)
+36: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:error</span>, <span class="ruby-identifier">msg</span>)
+37: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="execution-stack-method" class="method-detail ">
+ <a name="M000134"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">execution_stack</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+this method is here to facilitate testing
+</p>
+
+
+
+ <div class="method-source-code"
+ id="execution-stack-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 170</span>
+170: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execution_stack</span>
+171: <span class="ruby-identifier">caller</span>
+172: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="fatal-method" class="method-detail ">
+ <a name="M000119"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">fatal</span><span
+ class="method-args">(msg)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Logs at fatal level
+</p>
+
+
+
+ <div class="method-source-code"
+ id="fatal-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 30</span>
+30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fatal</span>(<span class="ruby-identifier">msg</span>)
+31: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:fatal</span>, <span class="ruby-identifier">msg</span>)
+32: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="from-method" class="method-detail ">
+ <a name="M000133"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">from</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+figures out the filename that called us
+</p>
+
+
+
+ <div class="method-source-code"
+ id="from-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 164</span>
+164: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">from</span>
+165: <span class="ruby-identifier">path</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">method</span> = <span class="ruby-identifier">execution_stack</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/:(\d+)/</span>)
+166: <span class="ruby-value str">"%s:%s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">path</span>), <span class="ruby-identifier">line</span>, <span class="ruby-identifier">method</span>]
+167: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="info-method" class="method-detail ">
+ <a name="M000116"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">info</span><span
+ class="method-args">(msg)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Logs at info level
+</p>
+
+
+
+ <div class="method-source-code"
+ id="info-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 15</span>
+15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">info</span>(<span class="ruby-identifier">msg</span>)
+16: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:info</span>, <span class="ruby-identifier">msg</span>)
+17: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="instance-method" class="method-detail ">
+ <a name="M000121"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">instance</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+handle old code that relied on this class being a singleton
+</p>
+
+
+
+ <div class="method-source-code"
+ id="instance-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 40</span>
+40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">instance</span>
+41: <span class="ruby-keyword kw">self</span>
+42: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="log-method" class="method-detail ">
+ <a name="M000129"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">log</span><span
+ class="method-args">(level, msg, origin=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+logs a message at a certain level
+</p>
+
+
+
+ <div class="method-source-code"
+ id="log-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 106</span>
+106: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">origin</span>=<span class="ruby-keyword kw">nil</span>)
+107: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config_and_check_level</span>(<span class="ruby-identifier">level</span>)
+108:
+109: <span class="ruby-identifier">origin</span> = <span class="ruby-identifier">from</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">origin</span>
+110:
+111: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@logger</span>
+112: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">origin</span>, <span class="ruby-identifier">msg</span>)
+113: <span class="ruby-keyword kw">else</span>
+114: <span class="ruby-identifier">t</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">"%H:%M:%S"</span>)
+115:
+116: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"#{t}: #{level}: #{origin}: #{msg}"</span>
+117: <span class="ruby-keyword kw">end</span>
+118: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="logexception-method" class="method-detail ">
+ <a name="M000127"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">logexception</span><span
+ class="method-args">(msgid, level, e, backtrace=false, args={})</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="logexception-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 67</span>
+67: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">e</span>, <span class="ruby-identifier">backtrace</span>=<span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">args</span>={})
+68: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config_and_check_level</span>(<span class="ruby-identifier">level</span>)
+69:
+70: <span class="ruby-identifier">path</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">method</span> = <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/:(\d+)/</span>)
+71: <span class="ruby-identifier">origin</span> = <span class="ruby-value str">"%s:%s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">path</span>), <span class="ruby-identifier">line</span>, <span class="ruby-identifier">method</span>]
+72:
+73: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">CodedError</span>)
+74: <span class="ruby-identifier">msg</span> = <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">code</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>]
+75: <span class="ruby-keyword kw">else</span>
+76: <span class="ruby-identifier">error_string</span> = <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>]
+77: <span class="ruby-identifier">msg</span> = <span class="ruby-identifier">message_for</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">error_string</span>))
+78: <span class="ruby-keyword kw">end</span>
+79:
+80: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">origin</span>)
+81:
+82: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">backtrace</span>
+83: <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
+84: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">line</span>], <span class="ruby-identifier">origin</span>)
+85: <span class="ruby-keyword kw">end</span>
+86: <span class="ruby-keyword kw">end</span>
+87: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="logger-method" class="method-detail ">
+ <a name="M000115"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">logger</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Obtain the class name of the currently configured logger
+</p>
+
+
+
+ <div class="method-source-code"
+ id="logger-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 10</span>
+10: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logger</span>
+11: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">class</span>
+12: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="logmsg-method" class="method-detail ">
+ <a name="M000128"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">logmsg</span><span
+ class="method-args">(msgid, default, level, args={})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Logs a message at a certain level, the message must be a token that will be
+looked up from the i18n localization database
+</p>
+<p>
+Messages can interprolate strings from the args hash, a message with
+“foo %{bar}” in the localization database will use args[:bar]
+for the value there, the interprolation is handled by the i18n library
+itself
+</p>
+
+
+
+ <div class="method-source-code"
+ id="logmsg-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 97</span>
+ 97: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logmsg</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>={})
+ 98: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config_and_check_level</span>(<span class="ruby-identifier">level</span>)
+ 99:
+100: <span class="ruby-identifier">msg</span> = <span class="ruby-identifier">message_for</span>(<span class="ruby-identifier">msgid</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))
+101:
+102: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>)
+103: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="message-for-method" class="method-detail ">
+ <a name="M000126"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">message_for</span><span
+ class="method-args">(msgid, args={})</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="message-for-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 63</span>
+63: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">message_for</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>={})
+64: <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">msgid</span>, <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>)]
+65: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="set-logger-method" class="method-detail ">
+ <a name="M000130"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">set_logger</span><span
+ class="method-args">(logger)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+sets the logger class to use
+</p>
+
+
+
+ <div class="method-source-code"
+ id="set-logger-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 121</span>
+121: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logger</span>(<span class="ruby-identifier">logger</span>)
+122: <span class="ruby-ivar">@logger</span> = <span class="ruby-identifier">logger</span>
+123: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="unconfigure-method" class="method-detail ">
+ <a name="M000132"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">unconfigure</span><span
+ class="method-args">()</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="unconfigure-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 158</span>
+158: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unconfigure</span>
+159: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">false</span>
+160: <span class="ruby-identifier">set_logger</span>(<span class="ruby-keyword kw">nil</span>)
+161: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="valid-level--method" class="method-detail ">
+ <a name="M000125"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">valid_level?</span><span
+ class="method-args">(level)</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="valid-level--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 59</span>
+59: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_level?</span>(<span class="ruby-identifier">level</span>)
+60: <span class="ruby-constant">VALID_LEVELS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">level</span>)
+61: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="warn-method" class="method-detail ">
+ <a name="M000117"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">warn</span><span
+ class="method-args">(msg)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Logs at warn level
+</p>
+
+
+
+ <div class="method-source-code"
+ id="warn-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 20</span>
+20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">warn</span>(<span class="ruby-identifier">msg</span>)
+21: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">msg</span>)
+22: <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>
+
--- /dev/null
+<?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>Module: MCollective::Logger</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="module">
+
+ <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/logger_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger.rb">lib/mcollective/logger.rb</a></li>
+
+ <li><a href="../lib/mcollective/logger/console_logger_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger/console_logger.rb">lib/mcollective/logger/console_logger.rb</a></li>
+
+ <li><a href="../lib/mcollective/logger/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger/base.rb">lib/mcollective/logger/base.rb</a></li>
+
+ <li><a href="../lib/mcollective/logger/syslog_logger_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger/syslog_logger.rb">lib/mcollective/logger/syslog_logger.rb</a></li>
+
+ <li><a href="../lib/mcollective/logger/file_logger_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger/file_logger.rb">lib/mcollective/logger/file_logger.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="Logger/Base.html">MCollective::Logger::Base</a></li>
+
+ <li><span class="type">CLASS</span> <a href="Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
+
+ <li><span class="type">CLASS</span> <a href="Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
+
+ <li><span class="type">CLASS</span> <a href="Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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="module">MCollective::Logger</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::Logger::Base</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/logger/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger/base.rb">lib/mcollective/logger/base.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="#M000166">::new</a></li>
+
+ <li><a href="#M000168">#cycle_level</a></li>
+
+ <li><a href="#M000171">#get_next_level</a></li>
+
+ <li><a href="#M000173">#log</a></li>
+
+ <li><a href="#M000170">#map_level</a></li>
+
+ <li><a href="#M000169">#set_level</a></li>
+
+ <li><a href="#M000167">#should_log?</a></li>
+
+ <li><a href="#M000174">#start</a></li>
+
+ <li><a href="#M000172">#valid_levels</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::Logger::Base</h1>
+
+ <div id="description">
+ <p>
+A base class for logging providers.
+</p>
+<p>
+Logging providers should provide the following:
+</p>
+<pre>
+ * start - all you need to do to setup your logging
+ * set_logging_level - set your logging to :info, :warn, etc
+ * valid_levels - a hash of maps from :info to your internal level name
+ * log - what needs to be done to log a specific message
+</pre>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="active-level-attribute-method" class="method-detail">
+ <a name="active_level"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">active_level</span><span
+ class="attribute-access-type">[R]</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="M000166"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">()</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/logger/base.rb, line 14</span>
+14: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+15: <span class="ruby-ivar">@known_levels</span> = [<span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:info</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:fatal</span>]
+16:
+17: <span class="ruby-comment cmt"># Sanity check the class that impliments the logging</span>
+18: <span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">lvl</span><span class="ruby-operator">|</span>
+19: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Logger class did not specify a map for #{lvl}"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">valid_levels</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">lvl</span>)
+20: <span class="ruby-keyword kw">end</span>
+21: <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="cycle-level-method" class="method-detail ">
+ <a name="M000168"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">cycle_level</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Figures out the next level and sets it
+</p>
+
+
+
+ <div class="method-source-code"
+ id="cycle-level-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 28</span>
+28: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cycle_level</span>
+29: <span class="ruby-identifier">lvl</span> = <span class="ruby-identifier">get_next_level</span>
+30: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">lvl</span>)
+31:
+32: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">lvl</span>, <span class="ruby-value str">""</span>, <span class="ruby-node">"Logging level is now #{lvl.to_s.upcase}"</span>)
+33: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="set-level-method" class="method-detail ">
+ <a name="M000169"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">set_level</span><span
+ class="method-args">(level)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sets a new level and record it in @<a
+href="Base.html#active_level">active_level</a>
+</p>
+
+
+
+ <div class="method-source-code"
+ id="set-level-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 36</span>
+36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">level</span>)
+37: <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
+38: <span class="ruby-ivar">@active_level</span> = <span class="ruby-identifier">level</span>.<span class="ruby-identifier">to_sym</span>
+39: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="should-log--method" class="method-detail ">
+ <a name="M000167"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">should_log?</span><span
+ class="method-args">(level)</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="should-log--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 23</span>
+23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">should_log?</span>(<span class="ruby-identifier">level</span>)
+24: <span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">level</span>) <span class="ruby-operator">>=</span> <span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">index</span>(<span class="ruby-ivar">@active_level</span>)
+25: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+ <div id="private-instance-method-details" class="method-section section">
+ <h3 class="section-header">Private Instance Methods</h3>
+
+
+ <div id="get-next-level-method" class="method-detail ">
+ <a name="M000171"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">get_next_level</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Gets the next level in the list, cycles down to the firt once it reaches
+the end
+</p>
+
+
+
+ <div class="method-source-code"
+ id="get-next-level-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 49</span>
+49: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_next_level</span>
+50: <span class="ruby-comment cmt"># if all else fails, always go to debug mode</span>
+51: <span class="ruby-identifier">nextlvl</span> = <span class="ruby-identifier">:debug</span>
+52:
+53: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">index</span>(<span class="ruby-ivar">@active_level</span>) <span class="ruby-operator">==</span> (<span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
+54: <span class="ruby-identifier">nextlvl</span> = <span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">first</span>
+55: <span class="ruby-keyword kw">else</span>
+56: <span class="ruby-identifier">idx</span> = <span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">index</span>(<span class="ruby-ivar">@active_level</span>) <span class="ruby-operator">+</span> <span class="ruby-value">1</span>
+57: <span class="ruby-identifier">nextlvl</span> = <span class="ruby-ivar">@known_levels</span>[<span class="ruby-identifier">idx</span>]
+58: <span class="ruby-keyword kw">end</span>
+59:
+60: <span class="ruby-identifier">nextlvl</span>
+61: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="log-method" class="method-detail ">
+ <a name="M000173"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">log</span><span
+ class="method-args">(level, from, msg)</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="log-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 68</span>
+68: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">msg</span>)
+69: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"The logging class did not supply a log method"</span>
+70: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="map-level-method" class="method-detail ">
+ <a name="M000170"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">map_level</span><span
+ class="method-args">(level)</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="map-level-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 42</span>
+42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">map_level</span>(<span class="ruby-identifier">level</span>)
+43: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Logger class do not know how to handle #{level} messages"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">valid_levels</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">level</span>.<span class="ruby-identifier">to_sym</span>)
+44:
+45: <span class="ruby-identifier">valid_levels</span>[<span class="ruby-identifier">level</span>.<span class="ruby-identifier">to_sym</span>]
+46: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="start-method" class="method-detail ">
+ <a name="M000174"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">start</span><span
+ class="method-args">()</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="start-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 72</span>
+72: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
+73: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"The logging class did not supply a start method"</span>
+74: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="valid-levels-method" class="method-detail ">
+ <a name="M000172"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">valid_levels</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Abstract methods to ensure the logging implimentations supply what they
+should
+</p>
+
+
+
+ <div class="method-source-code"
+ id="valid-levels-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 64</span>
+64: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_levels</span>
+65: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"The logging class did not supply a valid_levels method"</span>
+66: <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>
+
--- /dev/null
+<?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::Logger::Console_logger</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/logger/console_logger_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger/console_logger.rb">lib/mcollective/logger/console_logger.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">Base</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="#M000164">#color</a></li>
+
+ <li><a href="#M000165">#colorize</a></li>
+
+ <li><a href="#M000163">#log</a></li>
+
+ <li><a href="#M000161">#set_logging_level</a></li>
+
+ <li><a href="#M000160">#start</a></li>
+
+ <li><a href="#M000162">#valid_levels</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::Logger::Console_logger</h1>
+
+ <div id="description">
+ <p>
+Implements a syslog based logger using the standard ruby syslog class
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="color-method" class="method-detail ">
+ <a name="M000164"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">color</span><span
+ class="method-args">(level)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Set some colors for various logging levels, will honor the color
+configuration option and return nothing if its configured not to
+</p>
+
+
+
+ <div class="method-source-code"
+ id="color-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 37</span>
+37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">color</span>(<span class="ruby-identifier">level</span>)
+38: <span class="ruby-identifier">colorize</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">color</span>
+39:
+40: <span class="ruby-identifier">colors</span> = {<span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:red</span>),
+41: <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:red</span>),
+42: <span class="ruby-identifier">:warn</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:yellow</span>),
+43: <span class="ruby-identifier">:info</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:green</span>),
+44: <span class="ruby-identifier">:reset</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:reset</span>)}
+45:
+46: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">colorize</span>
+47: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">colors</span>[<span class="ruby-identifier">level</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">""</span>
+48: <span class="ruby-keyword kw">else</span>
+49: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span>
+50: <span class="ruby-keyword kw">end</span>
+51: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="colorize-method" class="method-detail ">
+ <a name="M000165"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">colorize</span><span
+ class="method-args">(level, msg)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Helper to return a string in specific color
+</p>
+
+
+
+ <div class="method-source-code"
+ id="colorize-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 54</span>
+54: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>)
+55: <span class="ruby-value str">"%s%s%s"</span> <span class="ruby-operator">%</span> [ <span class="ruby-identifier">color</span>(<span class="ruby-identifier">level</span>), <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">color</span>(<span class="ruby-identifier">:reset</span>) ]
+56: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="log-method" class="method-detail ">
+ <a name="M000163"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">log</span><span
+ class="method-args">(level, from, msg, normal_output=STDERR, last_resort_output=STDERR)</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="log-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 24</span>
+24: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">normal_output</span>=<span class="ruby-constant">STDERR</span>, <span class="ruby-identifier">last_resort_output</span>=<span class="ruby-constant">STDERR</span>)
+25: <span class="ruby-identifier">time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">"%Y/%m/%d %H:%M:%S"</span>)
+26:
+27: <span class="ruby-identifier">normal_output</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-value str">"%s %s: %s %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">level</span>), <span class="ruby-identifier">time</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">msg</span>])
+28: <span class="ruby-keyword kw">rescue</span>
+29: <span class="ruby-comment cmt"># if this fails we probably cant show the user output at all,</span>
+30: <span class="ruby-comment cmt"># STDERR it as last resort</span>
+31: <span class="ruby-identifier">last_resort_output</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-node">"#{level}: #{msg}"</span>)
+32: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="set-logging-level-method" class="method-detail ">
+ <a name="M000161"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">set_logging_level</span><span
+ class="method-args">(level)</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="set-logging-level-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 12</span>
+12: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
+13: <span class="ruby-comment cmt"># nothing to do here, we ignore high levels when we log</span>
+14: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="start-method" class="method-detail ">
+ <a name="M000160"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">start</span><span
+ class="method-args">()</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="start-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 5</span>
+ 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
+ 6: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">:info</span>)
+ 7:
+ 8: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
+ 9: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">loglevel</span>.<span class="ruby-identifier">to_sym</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">configured</span>
+10: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="valid-levels-method" class="method-detail ">
+ <a name="M000162"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">valid_levels</span><span
+ class="method-args">()</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="valid-levels-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 16</span>
+16: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_levels</span>
+17: {<span class="ruby-identifier">:info</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:info</span>,
+18: <span class="ruby-identifier">:warn</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:warning</span>,
+19: <span class="ruby-identifier">:debug</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:debug</span>,
+20: <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:crit</span>,
+21: <span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:err</span>}
+22: <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>
+
--- /dev/null
+<?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::Logger::File_logger</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/logger/file_logger_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger/file_logger.rb">lib/mcollective/logger/file_logger.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">Base</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="#M000183">#log</a></li>
+
+ <li><a href="#M000181">#set_logging_level</a></li>
+
+ <li><a href="#M000180">#start</a></li>
+
+ <li><a href="#M000182">#valid_levels</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::Logger::File_logger</h1>
+
+ <div id="description">
+ <p>
+Impliments a file based logger using the standard ruby logger class
+</p>
+<p>
+To configure you should set:
+</p>
+<pre>
+ - config.logfile
+ - config.keeplogs defaults to 2097152
+ - config.max_log_size defaults to 5
+</pre>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="log-method" class="method-detail ">
+ <a name="M000183"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">log</span><span
+ class="method-args">(level, from, msg)</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="log-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 37</span>
+37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">msg</span>)
+38: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">map_level</span>(<span class="ruby-identifier">level</span>)) { <span class="ruby-node">"#{from} #{msg}"</span> }
+39: <span class="ruby-keyword kw">rescue</span>
+40: <span class="ruby-comment cmt"># if this fails we probably cant show the user output at all,</span>
+41: <span class="ruby-comment cmt"># STDERR it as last resort</span>
+42: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-node">"#{level}: #{msg}"</span>)
+43: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="set-logging-level-method" class="method-detail ">
+ <a name="M000181"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">set_logging_level</span><span
+ class="method-args">(level)</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="set-logging-level-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 22</span>
+22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
+23: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">level</span> = <span class="ruby-identifier">map_level</span>(<span class="ruby-identifier">level</span>)
+24: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+25: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">level</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">DEBUG</span>
+26: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:error</span>, <span class="ruby-value str">""</span>, <span class="ruby-node">"Could not set logging to #{level} using debug instead: #{e.class} #{e}"</span>)
+27: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="start-method" class="method-detail ">
+ <a name="M000180"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">start</span><span
+ class="method-args">()</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="start-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 13</span>
+13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
+14: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
+15:
+16: <span class="ruby-ivar">@logger</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">logfile</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">keeplogs</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">max_log_size</span>)
+17: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">formatter</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">Formatter</span>.<span class="ruby-identifier">new</span>
+18:
+19: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">loglevel</span>.<span class="ruby-identifier">to_sym</span>)
+20: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="valid-levels-method" class="method-detail ">
+ <a name="M000182"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">valid_levels</span><span
+ class="method-args">()</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="valid-levels-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 29</span>
+29: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_levels</span>
+30: {<span class="ruby-identifier">:info</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">INFO</span>,
+31: <span class="ruby-identifier">:warn</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">WARN</span>,
+32: <span class="ruby-identifier">:debug</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">DEBUG</span>,
+33: <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">FATAL</span>,
+34: <span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">ERROR</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>
+
--- /dev/null
+<?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::Logger::Syslog_logger</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/logger/syslog_logger_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/logger/syslog_logger.rb">lib/mcollective/logger/syslog_logger.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">Base</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="#M000179">#log</a></li>
+
+ <li><a href="#M000177">#set_logging_level</a></li>
+
+ <li><a href="#M000175">#start</a></li>
+
+ <li><a href="#M000176">#syslog_facility</a></li>
+
+ <li><a href="#M000178">#valid_levels</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ <div id="includes-section" class="section">
+ <h3 class="section-header">Included Modules</h3>
+ <ul class="link-list">
+
+
+ <li><span class="include">Syslog::Constants</span></li>
+
+
+ </ul>
+ </div>
+
+ </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::Logger::Syslog_logger</h1>
+
+ <div id="description">
+ <p>
+Implements a syslog based logger using the standard ruby syslog class
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="log-method" class="method-detail ">
+ <a name="M000179"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">log</span><span
+ class="method-args">(level, from, msg)</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="log-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 42</span>
+42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">msg</span>)
+43: <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">map_level</span>(<span class="ruby-identifier">level</span>), <span class="ruby-node">"#{from} #{msg}"</span>)
+44: <span class="ruby-keyword kw">rescue</span>
+45: <span class="ruby-comment cmt"># if this fails we probably cant show the user output at all,</span>
+46: <span class="ruby-comment cmt"># STDERR it as last resort</span>
+47: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-node">"#{level}: #{msg}"</span>)
+48: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="set-logging-level-method" class="method-detail ">
+ <a name="M000177"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">set_logging_level</span><span
+ class="method-args">(level)</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="set-logging-level-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 30</span>
+30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
+31: <span class="ruby-comment cmt"># noop</span>
+32: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="start-method" class="method-detail ">
+ <a name="M000175"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">start</span><span
+ class="method-args">()</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="start-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 9</span>
+ 9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
+10: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
+11:
+12: <span class="ruby-identifier">facility</span> = <span class="ruby-identifier">syslog_facility</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">logfacility</span>)
+13: <span class="ruby-identifier">level</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">loglevel</span>.<span class="ruby-identifier">to_sym</span>
+14:
+15: <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">opened?</span>
+16: <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">$0</span>), <span class="ruby-value">3</span>, <span class="ruby-identifier">facility</span>)
+17:
+18: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">level</span>)
+19: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="syslog-facility-method" class="method-detail ">
+ <a name="M000176"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">syslog_facility</span><span
+ class="method-args">(facility)</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="syslog-facility-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 21</span>
+21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">syslog_facility</span>(<span class="ruby-identifier">facility</span>)
+22: <span class="ruby-keyword kw">begin</span>
+23: <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-node">"LOG_#{facility.upcase}"</span>)
+24: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NameError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+25: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Invalid syslog facility #{facility} supplied, reverting to USER"</span>
+26: <span class="ruby-constant">Syslog</span><span class="ruby-operator">::</span><span class="ruby-constant">LOG_USER</span>
+27: <span class="ruby-keyword kw">end</span>
+28: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="valid-levels-method" class="method-detail ">
+ <a name="M000178"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">valid_levels</span><span
+ class="method-args">()</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="valid-levels-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 34</span>
+34: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_levels</span>
+35: {<span class="ruby-identifier">:info</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:info</span>,
+36: <span class="ruby-identifier">:warn</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:warning</span>,
+37: <span class="ruby-identifier">:debug</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:debug</span>,
+38: <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:crit</span>,
+39: <span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:err</span>}
+40: <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>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>Module: MCollective::Matcher</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+ <title>Module: MCollective::Matcher</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>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Matcher</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/matcher/scanner_rb.html">
- lib/mcollective/matcher/scanner.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/matcher/parser_rb.html">
- lib/mcollective/matcher/parser.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/matcher_rb.html">
- lib/mcollective/matcher.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
+<body class="module">
+
+ <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/matcher/scanner_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/matcher/scanner.rb">lib/mcollective/matcher/scanner.rb</a></li>
+
+ <li><a href="../lib/mcollective/matcher/parser_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/matcher/parser.rb">lib/mcollective/matcher/parser.rb</a></li>
+
+ <li><a href="../lib/mcollective/matcher_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/matcher.rb">lib/mcollective/matcher.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
+
+ <li><span class="type">CLASS</span> <a href="Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000065">::create_compound_callstack</a></li>
+
+ <li><a href="#M000052">::create_function_hash</a></li>
+
+ <li><a href="#M000059">::eval_compound_fstatement</a></li>
+
+ <li><a href="#M000054">::eval_compound_statement</a></li>
+
+ <li><a href="#M000053">::execute_function</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="module">MCollective::Matcher</h1>
+
+ <div id="description">
+ <p>
A parser and scanner that creates a stack machine for a simple fact and
class matching language used on the CLI to facilitate a rich discovery
language
Language EBNF
</p>
<p>
-compound = ["("] expression [")"] {["("]
-expression [")"]} expression = [!|not]statement
-["and"|"or"] [!|not] statement char = A-Z | a-z | <
-| > | => | =< | _ | - |* | / { A-Z | a-z | < | > | => |
-=< | _ | - | * | / | } int = 0|1|2|3|4|5|6|7|8|9{|0|1|2|3|4|5|6|7|8|9|0}
+compound = [“(“] expression [“)”]
+{[“(“] expression [“)”]} expression =
+[!|not]statement [“and”|“or”] [!|not] statement
+char = A-Z | a-z | < | > | => | =< | _ | - |* | / { A-Z | a-z | < | > | =>
+| =< | _ | - | * | / | } int = 0|1|2|3|4|5|6|7|8|9{|0|1|2|3|4|5|6|7|8|9|0}
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000147">create_compound_callstack</a>
- <a href="#M000143">create_function_hash</a>
- <a href="#M000146">eval_compound_fstatement</a>
- <a href="#M000145">eval_compound_statement</a>
- <a href="#M000144">execute_function</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
+ </div>
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
+ <!-- Constants -->
+
- Class <a href="Matcher/Parser.html" class="link">MCollective::Matcher::Parser</a><br />
-Class <a href="Matcher/Scanner.html" class="link">MCollective::Matcher::Scanner</a><br />
+ <!-- Attributes -->
+
- </div>
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+ <div id="create-compound-callstack-method" class="method-detail ">
+ <a name="M000065"></a>
+ <div class="method-heading">
+
+ <span class="method-name">create_compound_callstack</span><span
+ class="method-args">(call_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000147" class="method-detail">
- <a name="M000147"></a>
-
- <div class="method-heading">
- <a href="#M000147" class="method-signature">
- <span class="method-name">create_compound_callstack</span><span class="method-args">(call_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+ <div class="method-description">
+
+ <p>
Creates a callstack to be evaluated from a compound evaluation string
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000147-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000147-source">
+
+
+
+ <div class="method-source-code"
+ id="create-compound-callstack-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/matcher.rb, line 181</span>
181: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">create_compound_callstack</span>(<span class="ruby-identifier">call_string</span>)
186: <span class="ruby-keyword kw">end</span>
187: <span class="ruby-keyword kw">end</span>
188: <span class="ruby-identifier">callstack</span>
-189: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000143" class="method-detail">
- <a name="M000143"></a>
-
- <div class="method-heading">
- <a href="#M000143" class="method-signature">
- <span class="method-name">create_function_hash</span><span class="method-args">(function_call)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+189: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="create-function-hash-method" class="method-detail ">
+ <a name="M000052"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">create_function_hash</span><span
+ class="method-args">(function_call)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Helper creates a hash from a function call string
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000143-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000143-source">
+
+
+
+ <div class="method-source-code"
+ id="create-function-hash-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/matcher.rb, line 17</span>
17: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">create_function_hash</span>(<span class="ruby-identifier">function_call</span>)
72: <span class="ruby-keyword kw">end</span>
73:
74: <span class="ruby-identifier">func_hash</span>
-75: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000146" class="method-detail">
- <a name="M000146"></a>
-
- <div class="method-heading">
- <a href="#M000146" class="method-signature">
- <span class="method-name">eval_compound_fstatement</span><span class="method-args">(function_hash)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+75: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="eval-compound-fstatement-method" class="method-detail ">
+ <a name="M000059"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">eval_compound_fstatement</span><span
+ class="method-args">(function_hash)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns the result of an evaluated compound statement that includes a
function
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000146-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000146-source">
+
+
+
+ <div class="method-source-code"
+ id="eval-compound-fstatement-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/matcher.rb, line 135</span>
135: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">eval_compound_fstatement</span>(<span class="ruby-identifier">function_hash</span>)
175: <span class="ruby-identifier">result</span> = <span class="ruby-identifier">eval</span>(<span class="ruby-node">"#{l_compare} #{function_hash["operator"]} #{function_hash["r_compare"]}"</span>)
176: (<span class="ruby-identifier">result</span>.<span class="ruby-identifier">nil?</span>) <span class="ruby-operator">?</span> <span class="ruby-keyword kw">false</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">result</span>
177: <span class="ruby-keyword kw">end</span>
-178: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000145" class="method-detail">
- <a name="M000145"></a>
-
- <div class="method-heading">
- <a href="#M000145" class="method-signature">
- <span class="method-name">eval_compound_statement</span><span class="method-args">(expression)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+178: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="eval-compound-statement-method" class="method-detail ">
+ <a name="M000054"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">eval_compound_statement</span><span
+ class="method-args">(expression)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Evaluates a compound statement
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000145-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000145-source">
+
+
+
+ <div class="method-source-code"
+ id="eval-compound-statement-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/matcher.rb, line 115</span>
115: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">eval_compound_statement</span>(<span class="ruby-identifier">expression</span>)
128: <span class="ruby-keyword kw">else</span>
129: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">has_cf_class?</span>(<span class="ruby-identifier">expression</span>.<span class="ruby-identifier">values</span>.<span class="ruby-identifier">first</span>)
130: <span class="ruby-keyword kw">end</span>
-131: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000144" class="method-detail">
- <a name="M000144"></a>
-
- <div class="method-heading">
- <a href="#M000144" class="method-signature">
- <span class="method-name">execute_function</span><span class="method-args">(function_hash)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+131: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="execute-function-method" class="method-detail ">
+ <a name="M000053"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">execute_function</span><span
+ class="method-args">(function_hash)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns the result of an executed function
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000144-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000144-source">
+
+
+
+ <div class="method-source-code"
+ id="execute-function-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/matcher.rb, line 78</span>
78: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">execute_function</span>(<span class="ruby-identifier">function_hash</span>)
109: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NoMethodError</span>
110: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"cannot execute discovery function '#{function_hash["name"]}'. data plugin not found"</span>)
111: <span class="ruby-identifier">raise</span> <span class="ruby-constant">DDLValidationError</span>
-112: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+112: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </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>
-</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>
\ No newline at end of file
+</html>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>Class: MCollective::Matcher::Parser</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Matcher::Parser</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/matcher/parser_rb.html">
- lib/mcollective/matcher/parser.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- <div class="name-list">
- <a href="#M000151">exit_with_paren_errors</a>
- <a href="#M000150">exit_with_parse_errors</a>
- <a href="#M000149">exit_with_token_errors</a>
- <a href="#M000148">new</a>
- <a href="#M000152">parse</a>
- </div>
- </div>
+ <title>Class: MCollective::Matcher::Parser</title>
- </div>
+ <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>
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">execution_stack</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">scanner</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000148" class="method-detail">
- <a name="M000148"></a>
-
- <div class="method-heading">
- <a href="#M000148" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(args)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000148-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000148-source">
+</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/matcher/parser_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/matcher/parser.rb">lib/mcollective/matcher/parser.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="#M000044">::new</a></li>
+
+ <li><a href="#M000047">#exit_with_paren_errors</a></li>
+
+ <li><a href="#M000046">#exit_with_parse_errors</a></li>
+
+ <li><a href="#M000045">#exit_with_token_errors</a></li>
+
+ <li><a href="#M000048">#parse</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::Matcher::Parser</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="scanner-attribute-method" class="method-detail">
+ <a name="scanner"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">scanner</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="execution-stack-attribute-method" class="method-detail">
+ <a name="execution_stack"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">execution_stack</span><span
+ class="attribute-access-type">[R]</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="M000044"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(args)</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/matcher/parser.rb, line 6</span>
6: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">args</span>)
13: <span class="ruby-identifier">exit_with_token_errors</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@token_errors</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
14: <span class="ruby-identifier">exit_with_parse_errors</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@parse_errors</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
15: <span class="ruby-identifier">exit_with_paren_errors</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@paren_errors</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
-16: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000151" class="method-detail">
- <a name="M000151"></a>
-
- <div class="method-heading">
- <a href="#M000151" class="method-signature">
- <span class="method-name">exit_with_paren_errors</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000151-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000151-source">
+16: <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="exit-with-paren-errors-method" class="method-detail ">
+ <a name="M000047"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">exit_with_paren_errors</span><span
+ class="method-args">()</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="exit-with-paren-errors-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/matcher/parser.rb, line 37</span>
37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">exit_with_paren_errors</span>
39: <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">i</span>])
40: <span class="ruby-keyword kw">end</span>
41: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Missing parenthesis found while parsing -S input #{@scanner.arguments.join}"</span>
-42: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000150" class="method-detail">
- <a name="M000150"></a>
-
- <div class="method-heading">
- <a href="#M000150" class="method-signature">
- <span class="method-name">exit_with_parse_errors</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000150-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000150-source">
+42: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="exit-with-parse-errors-method" class="method-detail ">
+ <a name="M000046"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">exit_with_parse_errors</span><span
+ class="method-args">()</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="exit-with-parse-errors-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/matcher/parser.rb, line 28</span>
28: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">exit_with_parse_errors</span>
32: <span class="ruby-keyword kw">end</span>
33: <span class="ruby-keyword kw">end</span>
34: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Parse errors found while parsing -S input #{ @scanner.arguments.join}"</span>
-35: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000149" class="method-detail">
- <a name="M000149"></a>
-
- <div class="method-heading">
- <a href="#M000149" class="method-signature">
- <span class="method-name">exit_with_token_errors</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+35: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="exit-with-token-errors-method" class="method-detail ">
+ <a name="M000045"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">exit_with_token_errors</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Exit and highlight any malformed tokens
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000149-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000149-source">
+
+
+
+ <div class="method-source-code"
+ id="exit-with-token-errors-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/matcher/parser.rb, line 19</span>
19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">exit_with_token_errors</span>
23: <span class="ruby-keyword kw">end</span>
24: <span class="ruby-keyword kw">end</span>
25: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Malformed token(s) found while parsing -S input #{@scanner.arguments.join}"</span>
-26: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000152" class="method-detail">
- <a name="M000152"></a>
-
- <div class="method-heading">
- <a href="#M000152" class="method-signature">
- <span class="method-name">parse</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+26: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="parse-method" class="method-detail ">
+ <a name="M000048"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">parse</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Parse the input string, one token at a time a contruct the call stack
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000152-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000152-source">
+
+
+
+ <div class="method-source-code"
+ id="parse-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/matcher/parser.rb, line 45</span>
45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>
122: <span class="ruby-keyword kw">end</span>
123: <span class="ruby-identifier">pre_index</span> = <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">token_index</span>
124: <span class="ruby-keyword kw">end</span>
-125: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+125: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </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>
-</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>
\ No newline at end of file
+</html>
+
--- /dev/null
+<?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::Matcher::Scanner</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/matcher/scanner_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/matcher/scanner.rb">lib/mcollective/matcher/scanner.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="#M000041">::new</a></li>
+
+ <li><a href="#M000043">#gen_statement</a></li>
+
+ <li><a href="#M000042">#get_token</a></li>
+
+ <li><a href="#M000049">#is_klass?</a></li>
+
+ <li><a href="#M000050">#lookahead</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::Matcher::Scanner</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="arguments-attribute-method" class="method-detail">
+ <a name="arguments"></a>
+
+ <a name="arguments="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">arguments</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="token-index-attribute-method" class="method-detail">
+ <a name="token_index"></a>
+
+ <a name="token_index="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">token_index</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="M000041"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(arguments)</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/matcher/scanner.rb, line 6</span>
+ 6: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">arguments</span>)
+ 7: <span class="ruby-ivar">@token_index</span> = <span class="ruby-value">0</span>
+ 8: <span class="ruby-ivar">@arguments</span> = <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">""</span>)
+ 9: <span class="ruby-ivar">@seperation_counter</span> = <span class="ruby-value">0</span>
+10: <span class="ruby-ivar">@white_spaces</span> = <span class="ruby-value">0</span>
+11: <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="get-token-method" class="method-detail ">
+ <a name="M000042"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">get_token</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Scans the input string and identifies single language tokens
+</p>
+
+
+
+ <div class="method-source-code"
+ id="get-token-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/matcher/scanner.rb, line 14</span>
+14: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_token</span>
+15: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">>=</span> <span class="ruby-ivar">@arguments</span>.<span class="ruby-identifier">size</span>
+16: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
+17: <span class="ruby-keyword kw">end</span>
+18:
+19: <span class="ruby-keyword kw">case</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span>]
+20: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"("</span>
+21: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"("</span>, <span class="ruby-value str">"("</span>
+22:
+23: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">")"</span>
+24: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">")"</span>, <span class="ruby-value str">")"</span>
+25:
+26: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"n"</span>
+27: <span class="ruby-keyword kw">if</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"o"</span>) <span class="ruby-operator">&&</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"t"</span>) <span class="ruby-operator">&&</span> ((<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">" "</span>) <span class="ruby-operator">||</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"("</span>))
+28: <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+=</span> <span class="ruby-value">2</span>
+29: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"not"</span>, <span class="ruby-value str">"not"</span>
+30: <span class="ruby-keyword kw">else</span>
+31: <span class="ruby-identifier">gen_statement</span>
+32: <span class="ruby-keyword kw">end</span>
+33:
+34: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"!"</span>
+35: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"not"</span>, <span class="ruby-value str">"not"</span>
+36:
+37: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"a"</span>
+38: <span class="ruby-keyword kw">if</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"n"</span>) <span class="ruby-operator">&&</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"d"</span>) <span class="ruby-operator">&&</span> ((<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">" "</span>) <span class="ruby-operator">||</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"("</span>))
+39: <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+=</span> <span class="ruby-value">2</span>
+40: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"and"</span>, <span class="ruby-value str">"and"</span>
+41: <span class="ruby-keyword kw">else</span>
+42: <span class="ruby-identifier">gen_statement</span>
+43: <span class="ruby-keyword kw">end</span>
+44:
+45: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"o"</span>
+46: <span class="ruby-keyword kw">if</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"r"</span>) <span class="ruby-operator">&&</span> ((<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">" "</span>) <span class="ruby-operator">||</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"("</span>))
+47: <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+48: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"or"</span>, <span class="ruby-value str">"or"</span>
+49: <span class="ruby-keyword kw">else</span>
+50: <span class="ruby-identifier">gen_statement</span>
+51: <span class="ruby-keyword kw">end</span>
+52:
+53: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">" "</span>
+54: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">" "</span>, <span class="ruby-value str">" "</span>
+55:
+56: <span class="ruby-keyword kw">else</span>
+57: <span class="ruby-identifier">gen_statement</span>
+58: <span class="ruby-keyword kw">end</span>
+59: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+ <div id="private-instance-method-details" class="method-section section">
+ <h3 class="section-header">Private Instance Methods</h3>
+
+
+ <div id="gen-statement-method" class="method-detail ">
+ <a name="M000043"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">gen_statement</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Helper generates a statement token
+</p>
+
+
+
+ <div class="method-source-code"
+ id="gen-statement-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/matcher/scanner.rb, line 63</span>
+ 63: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gen_statement</span>
+ 64: <span class="ruby-identifier">func</span> = <span class="ruby-keyword kw">false</span>
+ 65: <span class="ruby-identifier">current_token_value</span> = <span class="ruby-value str">""</span>
+ 66: <span class="ruby-identifier">j</span> = <span class="ruby-ivar">@token_index</span>
+ 67:
+ 68: <span class="ruby-keyword kw">begin</span>
+ 69: <span class="ruby-keyword kw">if</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"/"</span>)
+ 70: <span class="ruby-keyword kw">begin</span>
+ 71: <span class="ruby-identifier">current_token_value</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>]
+ 72: <span class="ruby-identifier">j</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+ 73: <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">until</span> (<span class="ruby-identifier">j</span> <span class="ruby-operator">>=</span> <span class="ruby-ivar">@arguments</span>.<span class="ruby-identifier">size</span>) <span class="ruby-operator">||</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/\s/</span>)
+ 74: <span class="ruby-keyword kw">elsif</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/=|<|>/</span>)
+ 75: <span class="ruby-keyword kw">while</span> <span class="ruby-operator">!</span>(<span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/=|<|>/</span>)
+ 76: <span class="ruby-identifier">current_token_value</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>]
+ 77: <span class="ruby-identifier">j</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+ 78: <span class="ruby-keyword kw">end</span>
+ 79:
+ 80: <span class="ruby-identifier">current_token_value</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>]
+ 81: <span class="ruby-identifier">j</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+ 82:
+ 83: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"/"</span>
+ 84: <span class="ruby-keyword kw">begin</span>
+ 85: <span class="ruby-identifier">current_token_value</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>]
+ 86: <span class="ruby-identifier">j</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+ 87: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"/"</span>
+ 88: <span class="ruby-identifier">current_token_value</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"/"</span>
+ 89: <span class="ruby-keyword kw">break</span>
+ 90: <span class="ruby-keyword kw">end</span>
+ 91: <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">until</span> (<span class="ruby-identifier">j</span> <span class="ruby-operator">>=</span> <span class="ruby-ivar">@arguments</span>.<span class="ruby-identifier">size</span>) <span class="ruby-operator">||</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/\//</span>)
+ 92: <span class="ruby-keyword kw">else</span>
+ 93: <span class="ruby-keyword kw">while</span> (<span class="ruby-identifier">j</span> <span class="ruby-operator"><</span> <span class="ruby-ivar">@arguments</span>.<span class="ruby-identifier">size</span>) <span class="ruby-operator">&&</span> ((<span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">!=</span> <span class="ruby-value str">" "</span>) <span class="ruby-operator">&&</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">!=</span> <span class="ruby-value str">")"</span>))
+ 94: <span class="ruby-identifier">current_token_value</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>]
+ 95: <span class="ruby-identifier">j</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+ 96: <span class="ruby-keyword kw">end</span>
+ 97: <span class="ruby-keyword kw">end</span>
+ 98: <span class="ruby-keyword kw">else</span>
+ 99: <span class="ruby-keyword kw">begin</span>
+100: <span class="ruby-comment cmt"># Identify and tokenize regular expressions by ignoring everything between /'s</span>
+101: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">'/'</span>
+102: <span class="ruby-identifier">current_token_value</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">'/'</span>
+103: <span class="ruby-identifier">j</span><span class="ruby-operator">+=</span><span class="ruby-value">1</span>
+104: <span class="ruby-keyword kw">while</span>(<span class="ruby-identifier">j</span> <span class="ruby-operator"><</span> <span class="ruby-ivar">@arguments</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">!=</span> <span class="ruby-value str">'/'</span>)
+105: <span class="ruby-identifier">current_token_value</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>]
+106: <span class="ruby-identifier">j</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+107: <span class="ruby-keyword kw">end</span>
+108: <span class="ruby-identifier">current_token_value</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>]
+109: <span class="ruby-keyword kw">break</span>
+110: <span class="ruby-keyword kw">end</span>
+111: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span><span class="ruby-operator">+</span><span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"("</span>
+112: <span class="ruby-identifier">func</span> = <span class="ruby-keyword kw">true</span>
+113: <span class="ruby-identifier">be_greedy</span> = <span class="ruby-keyword kw">true</span>
+114: <span class="ruby-keyword kw">end</span>
+115: <span class="ruby-identifier">current_token_value</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>]
+116: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">be_greedy</span>
+117: <span class="ruby-keyword kw">while</span> <span class="ruby-operator">!</span>(<span class="ruby-identifier">j</span><span class="ruby-operator">+</span><span class="ruby-value">1</span> <span class="ruby-operator">>=</span> <span class="ruby-ivar">@arguments</span>.<span class="ruby-identifier">size</span>) <span class="ruby-operator">&&</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">!=</span> <span class="ruby-value str">')'</span>
+118: <span class="ruby-identifier">j</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+119: <span class="ruby-identifier">current_token_value</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>]
+120: <span class="ruby-keyword kw">end</span>
+121: <span class="ruby-identifier">j</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+122: <span class="ruby-identifier">be_greedy</span> = <span class="ruby-keyword kw">false</span>
+123: <span class="ruby-keyword kw">else</span>
+124: <span class="ruby-identifier">j</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+125: <span class="ruby-keyword kw">end</span>
+126: <span class="ruby-keyword kw">if</span>(<span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">' '</span>)
+127: <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">is_klass?</span>(<span class="ruby-identifier">j</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span>(<span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span><span class="ruby-operator">-</span><span class="ruby-value">1</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/=|<|>/</span>))
+128: <span class="ruby-keyword kw">end</span>
+129: <span class="ruby-keyword kw">if</span>( (<span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">' '</span>) <span class="ruby-operator">&&</span> (<span class="ruby-ivar">@seperation_counter</span> <span class="ruby-operator"><</span> <span class="ruby-value">2</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span>(<span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^.+(=|<|>).+$/</span>)) )
+130: <span class="ruby-keyword kw">if</span>((<span class="ruby-identifier">index</span> = <span class="ruby-identifier">lookahead</span>(<span class="ruby-identifier">j</span>)))
+131: <span class="ruby-identifier">j</span> = <span class="ruby-identifier">index</span>
+132: <span class="ruby-keyword kw">end</span>
+133: <span class="ruby-keyword kw">end</span>
+134: <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">until</span> (<span class="ruby-identifier">j</span> <span class="ruby-operator">>=</span> <span class="ruby-ivar">@arguments</span>.<span class="ruby-identifier">size</span>) <span class="ruby-operator">||</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/\s|\)/</span>)
+135: <span class="ruby-ivar">@seperation_counter</span> = <span class="ruby-value">0</span>
+136: <span class="ruby-keyword kw">end</span>
+137: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+138: <span class="ruby-identifier">raise</span> <span class="ruby-node">"An exception was raised while trying to tokenize '#{current_token_value} - #{e}'"</span>
+139: <span class="ruby-keyword kw">end</span>
+140:
+141: <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@white_spaces</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>
+142: <span class="ruby-ivar">@white_spaces</span> = <span class="ruby-value">0</span>
+143:
+144: <span class="ruby-comment cmt"># bar(</span>
+145: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/.+?\($/</span>)
+146: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"bad_token"</span>, [<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>, <span class="ruby-ivar">@token_index</span>]
+147: <span class="ruby-comment cmt"># /foo/=bar</span>
+148: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^\/.+?\/(<|>|=).+/</span>)
+149: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"bad_token"</span>, [<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>, <span class="ruby-ivar">@token_index</span>]
+150: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^.+?\/(<|>|=).+/</span>)
+151: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"bad_token"</span>, [<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>, <span class="ruby-ivar">@token_index</span>]
+152: <span class="ruby-keyword kw">else</span>
+153: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">func</span>
+154: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^.+?\((\s*(')[^']*(')\s*(,\s*(')[^']*('))*)?\)(\.[a-zA-Z0-9_]+)?((!=|<=|>=|=|>|<).+)?$/</span>) <span class="ruby-operator">||</span>
+155: <span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^.+?\((\s*(")[^"]*(")\s*(,\s*(")[^"]*("))*)?\)(\.[a-zA-Z0-9_]+)?((!=|<=|>=|=|>|<).+)?$/</span>)
+156: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"fstatement"</span>, <span class="ruby-identifier">current_token_value</span>
+157: <span class="ruby-keyword kw">else</span>
+158: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"bad_token"</span>, [<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>, <span class="ruby-ivar">@token_index</span>]
+159: <span class="ruby-keyword kw">end</span>
+160: <span class="ruby-keyword kw">else</span>
+161: <span class="ruby-identifier">slash_err</span> = <span class="ruby-keyword kw">false</span>
+162: <span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">''</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
+163: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'/'</span>
+164: <span class="ruby-identifier">slash_err</span> = <span class="ruby-operator">!</span><span class="ruby-identifier">slash_err</span>
+165: <span class="ruby-keyword kw">end</span>
+166: <span class="ruby-keyword kw">end</span>
+167: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"bad_token"</span>, [<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">current_token_value</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>, <span class="ruby-ivar">@token_index</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">slash_err</span>
+168: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"statement"</span>, <span class="ruby-identifier">current_token_value</span>
+169: <span class="ruby-keyword kw">end</span>
+170: <span class="ruby-keyword kw">end</span>
+171: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="is-klass--method" class="method-detail ">
+ <a name="M000049"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">is_klass?</span><span
+ class="method-args">(j)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Deal with special puppet class statement
+</p>
+
+
+
+ <div class="method-source-code"
+ id="is-klass--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/matcher/scanner.rb, line 174</span>
+174: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">is_klass?</span>(<span class="ruby-identifier">j</span>)
+175: <span class="ruby-keyword kw">while</span>(<span class="ruby-identifier">j</span> <span class="ruby-operator"><</span> <span class="ruby-ivar">@arguments</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">' '</span>)
+176: <span class="ruby-identifier">j</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+177: <span class="ruby-keyword kw">end</span>
+178:
+179: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">j</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/=|<|>/</span>
+180: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+181: <span class="ruby-keyword kw">else</span>
+182: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+183: <span class="ruby-keyword kw">end</span>
+184: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="lookahead-method" class="method-detail ">
+ <a name="M000050"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">lookahead</span><span
+ class="method-args">(index)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Eat spaces while looking for the next comparison symbol
+</p>
+
+
+
+ <div class="method-source-code"
+ id="lookahead-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/matcher/scanner.rb, line 187</span>
+187: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lookahead</span>(<span class="ruby-identifier">index</span>)
+188: <span class="ruby-identifier">index</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+189: <span class="ruby-keyword kw">while</span>(<span class="ruby-identifier">index</span> <span class="ruby-operator"><=</span> <span class="ruby-ivar">@arguments</span>.<span class="ruby-identifier">size</span>)
+190: <span class="ruby-ivar">@white_spaces</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+191: <span class="ruby-keyword kw">unless</span>(<span class="ruby-ivar">@arguments</span>[<span class="ruby-identifier">index</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/\s/</span>)
+192: <span class="ruby-ivar">@seperation_counter</span> <span class="ruby-operator">+=</span><span class="ruby-value">1</span>
+193: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">index</span>
+194: <span class="ruby-keyword kw">end</span>
+195: <span class="ruby-identifier">index</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+196: <span class="ruby-keyword kw">end</span>
+197: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
+198: <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>
+
--- /dev/null
+<?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::Message</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/message_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/message.rb">lib/mcollective/message.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="#M000051">::new</a></li>
+
+ <li><a href="#M000061">#base64?</a></li>
+
+ <li><a href="#M000058">#base64_decode!</a></li>
+
+ <li><a href="#M000060">#base64_encode!</a></li>
+
+ <li><a href="#M000068">#create_reqid</a></li>
+
+ <li><a href="#M000064">#decode!</a></li>
+
+ <li><a href="#M000062">#encode!</a></li>
+
+ <li><a href="#M000057">#expected_msgid=</a></li>
+
+ <li><a href="#M000067">#publish</a></li>
+
+ <li><a href="#M000056">#reply_to=</a></li>
+
+ <li><a href="#M000055">#type=</a></li>
+
+ <li><a href="#M000066">#validate</a></li>
+
+ <li><a href="#M000063">#validate_compound_filter</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::Message</h1>
+
+ <div id="description">
+ <p>
+container for a message, its headers, agent, collective and other meta data
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+ <div id="constants-list" class="section">
+ <h3 class="section-header">Constants</h3>
+ <dl>
+
+ <dt><a name="VALIDTYPES">VALIDTYPES</a></dt>
+
+ <dd class="description missing-docs">(Not documented)</dd>
+
+
+ </dl>
+ </div>
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="message-attribute-method" class="method-detail">
+ <a name="message"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">message</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="request-attribute-method" class="method-detail">
+ <a name="request"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">request</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="validated-attribute-method" class="method-detail">
+ <a name="validated"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">validated</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="msgtime-attribute-method" class="method-detail">
+ <a name="msgtime"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">msgtime</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="payload-attribute-method" class="method-detail">
+ <a name="payload"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">payload</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="type-attribute-method" class="method-detail">
+ <a name="type"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">type</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="expected-msgid-attribute-method" class="method-detail">
+ <a name="expected_msgid"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">expected_msgid</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="reply-to-attribute-method" class="method-detail">
+ <a name="reply_to"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">reply_to</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="headers-attribute-method" class="method-detail">
+ <a name="headers"></a>
+
+ <a name="headers="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">headers</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="agent-attribute-method" class="method-detail">
+ <a name="agent"></a>
+
+ <a name="agent="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">agent</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="collective-attribute-method" class="method-detail">
+ <a name="collective"></a>
+
+ <a name="collective="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">collective</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="filter-attribute-method" class="method-detail">
+ <a name="filter"></a>
+
+ <a name="filter="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">filter</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="requestid-attribute-method" class="method-detail">
+ <a name="requestid"></a>
+
+ <a name="requestid="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">requestid</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="discovered-hosts-attribute-method" class="method-detail">
+ <a name="discovered_hosts"></a>
+
+ <a name="discovered_hosts="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">discovered_hosts</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="options-attribute-method" class="method-detail">
+ <a name="options"></a>
+
+ <a name="options="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">options</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ttl-attribute-method" class="method-detail">
+ <a name="ttl"></a>
+
+ <a name="ttl="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ttl</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="M000051"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(payload, message, options = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+payload - the message body without headers etc, just the text message - the
+original message received from the middleware options[:base64] - if the
+body base64 encoded? options[:agent] - the agent the message is for/from
+options[:collective] - the collective its for/from options[:headers] - the
+message headers options[:type] - an indicator about the type of message,
+:message, :request, :direct_request or :reply options[:request] - if this
+is a reply this should old the message we are replying to options[:filter]
+- for requests, the filter to encode into the message options[:options] -
+the normal client options hash options[:ttl] - the maximum amount of
+seconds this message can be valid for options[:<a
+href="Message.html#expected_msgid">expected_msgid</a>] - in the case of
+replies this is the msgid it is expecting in the replies
+options[:requestid] - specific request id to use else one will be generated
+</p>
+
+
+
+ <div class="method-source-code"
+ id="new-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 23</span>
+23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">payload</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">options</span> = {})
+24: <span class="ruby-identifier">options</span> = {<span class="ruby-identifier">:base64</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>,
+25: <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>,
+26: <span class="ruby-identifier">:headers</span> =<span class="ruby-operator">></span> {},
+27: <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:message</span>,
+28: <span class="ruby-identifier">:request</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>,
+29: <span class="ruby-identifier">:filter</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter</span>,
+30: <span class="ruby-identifier">:options</span> =<span class="ruby-operator">></span> {},
+31: <span class="ruby-identifier">:ttl</span> =<span class="ruby-operator">></span> <span class="ruby-value">60</span>,
+32: <span class="ruby-identifier">:expected_msgid</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>,
+33: <span class="ruby-identifier">:requestid</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>,
+34: <span class="ruby-identifier">:collective</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>)
+35:
+36: <span class="ruby-ivar">@payload</span> = <span class="ruby-identifier">payload</span>
+37: <span class="ruby-ivar">@message</span> = <span class="ruby-identifier">message</span>
+38: <span class="ruby-ivar">@requestid</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:requestid</span>]
+39: <span class="ruby-ivar">@discovered_hosts</span> = <span class="ruby-keyword kw">nil</span>
+40: <span class="ruby-ivar">@reply_to</span> = <span class="ruby-keyword kw">nil</span>
+41:
+42: <span class="ruby-ivar">@type</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:type</span>]
+43: <span class="ruby-ivar">@headers</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:headers</span>]
+44: <span class="ruby-ivar">@base64</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:base64</span>]
+45: <span class="ruby-ivar">@filter</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:filter</span>]
+46: <span class="ruby-ivar">@expected_msgid</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:expected_msgid</span>]
+47: <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:options</span>]
+48:
+49: <span class="ruby-ivar">@ttl</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:ttl</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">ttl</span>
+50: <span class="ruby-ivar">@msgtime</span> = <span class="ruby-value">0</span>
+51:
+52: <span class="ruby-ivar">@validated</span> = <span class="ruby-keyword kw">false</span>
+53:
+54: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:request</span>]
+55: <span class="ruby-ivar">@request</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:request</span>]
+56: <span class="ruby-ivar">@agent</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">agent</span>
+57: <span class="ruby-ivar">@collective</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">collective</span>
+58: <span class="ruby-ivar">@type</span> = <span class="ruby-identifier">:reply</span>
+59: <span class="ruby-keyword kw">else</span>
+60: <span class="ruby-ivar">@agent</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:agent</span>]
+61: <span class="ruby-ivar">@collective</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:collective</span>]
+62: <span class="ruby-keyword kw">end</span>
+63:
+64: <span class="ruby-identifier">base64_decode!</span>
+65: <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="base--method" class="method-detail ">
+ <a name="M000061"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">base64?</span><span
+ class="method-args">()</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="base--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 129</span>
+129: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">base64?</span>
+130: <span class="ruby-ivar">@base64</span>
+131: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="base-decode--method" class="method-detail ">
+ <a name="M000058"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">base64_decode!</span><span
+ class="method-args">()</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="base-decode--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 115</span>
+115: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">base64_decode!</span>
+116: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@base64</span>
+117:
+118: <span class="ruby-ivar">@payload</span> = <span class="ruby-constant">SSL</span>.<span class="ruby-identifier">base64_decode</span>(<span class="ruby-ivar">@payload</span>)
+119: <span class="ruby-ivar">@base64</span> = <span class="ruby-keyword kw">false</span>
+120: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="base-encode--method" class="method-detail ">
+ <a name="M000060"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">base64_encode!</span><span
+ class="method-args">()</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="base-encode--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 122</span>
+122: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">base64_encode!</span>
+123: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@base64</span>
+124:
+125: <span class="ruby-ivar">@payload</span> = <span class="ruby-constant">SSL</span>.<span class="ruby-identifier">base64_encode</span>(<span class="ruby-ivar">@payload</span>)
+126: <span class="ruby-ivar">@base64</span> = <span class="ruby-keyword kw">true</span>
+127: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="create-reqid-method" class="method-detail ">
+ <a name="M000068"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">create_reqid</span><span
+ class="method-args">()</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="create-reqid-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 226</span>
+226: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_reqid</span>
+227: <span class="ruby-comment cmt"># we gsub out the -s so that the format of the id does not</span>
+228: <span class="ruby-comment cmt"># change from previous versions, these should just be more</span>
+229: <span class="ruby-comment cmt"># unique than previous ones</span>
+230: <span class="ruby-constant">SSL</span>.<span class="ruby-identifier">uuid</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">"-"</span>, <span class="ruby-value str">""</span>)
+231: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="decode--method" class="method-detail ">
+ <a name="M000064"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">decode!</span><span
+ class="method-args">()</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="decode--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 175</span>
+175: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">decode!</span>
+176: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Cannot decode message type #{type}"</span> <span class="ruby-keyword kw">unless</span> [<span class="ruby-identifier">:request</span>, <span class="ruby-identifier">:reply</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">type</span>)
+177:
+178: <span class="ruby-ivar">@payload</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>].<span class="ruby-identifier">decodemsg</span>(<span class="ruby-keyword kw">self</span>)
+179:
+180: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:request</span>
+181: <span class="ruby-identifier">raise</span> <span class="ruby-value str">'callerid in request is not valid, surpressing reply to potentially forged request'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>].<span class="ruby-identifier">valid_callerid?</span>(<span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:callerid</span>])
+182: <span class="ruby-keyword kw">end</span>
+183:
+184: [<span class="ruby-identifier">:collective</span>, <span class="ruby-identifier">:agent</span>, <span class="ruby-identifier">:filter</span>, <span class="ruby-identifier">:requestid</span>, <span class="ruby-identifier">:ttl</span>, <span class="ruby-identifier">:msgtime</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">prop</span><span class="ruby-operator">|</span>
+185: <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">"@#{prop}"</span>, <span class="ruby-identifier">payload</span>[<span class="ruby-identifier">prop</span>]) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">prop</span>)
+186: <span class="ruby-keyword kw">end</span>
+187: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="encode--method" class="method-detail ">
+ <a name="M000062"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">encode!</span><span
+ class="method-args">()</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="encode--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 133</span>
+133: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">encode!</span>
+134: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">type</span>
+135: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:reply</span>
+136: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Cannot encode a reply message if no request has been associated with it"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">request</span>
+137: <span class="ruby-identifier">raise</span> <span class="ruby-value str">'callerid in original request is not valid, surpressing reply to potentially forged request'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>].<span class="ruby-identifier">valid_callerid?</span>(<span class="ruby-identifier">request</span>.<span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:callerid</span>])
+138:
+139: <span class="ruby-ivar">@requestid</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:requestid</span>]
+140: <span class="ruby-ivar">@payload</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>].<span class="ruby-identifier">encodereply</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">payload</span>, <span class="ruby-identifier">requestid</span>, <span class="ruby-identifier">request</span>.<span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:callerid</span>])
+141: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:request</span>, <span class="ruby-identifier">:direct_request</span>
+142: <span class="ruby-identifier">validate_compound_filter</span>(<span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"compound"</span>]) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"compound"</span>].<span class="ruby-identifier">empty?</span>
+143:
+144: <span class="ruby-ivar">@requestid</span> = <span class="ruby-identifier">create_reqid</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@requestid</span>
+145: <span class="ruby-ivar">@payload</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>].<span class="ruby-identifier">encoderequest</span>(<span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">identity</span>, <span class="ruby-identifier">payload</span>, <span class="ruby-identifier">requestid</span>, <span class="ruby-identifier">filter</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">collective</span>, <span class="ruby-identifier">ttl</span>)
+146: <span class="ruby-keyword kw">else</span>
+147: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Cannot encode #{type} messages"</span>
+148: <span class="ruby-keyword kw">end</span>
+149: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="expected-msgid--method" class="method-detail ">
+ <a name="M000057"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">expected_msgid=</span><span
+ class="method-args">(msgid)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+in the case of reply messages we are expecting replies to a previously
+created message. This stores a hint to that previously sent message id and
+can be used by other classes like the security plugins as a means of
+optimizing their behavior like by ignoring messages not directed at us.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="expected-msgid--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 110</span>
+110: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">expected_msgid=</span>(<span class="ruby-identifier">msgid</span>)
+111: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Can only store the expected msgid for reply messages"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@type</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:reply</span>
+112: <span class="ruby-ivar">@expected_msgid</span> = <span class="ruby-identifier">msgid</span>
+113: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="publish-method" class="method-detail ">
+ <a name="M000067"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">publish</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+publish a reply message by creating a target name and sending it
+</p>
+
+
+
+ <div class="method-source-code"
+ id="publish-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 213</span>
+213: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">publish</span>
+214: <span class="ruby-comment cmt"># If we've been specificaly told about hosts that were discovered</span>
+215: <span class="ruby-comment cmt"># use that information to do P2P calls if appropriate else just</span>
+216: <span class="ruby-comment cmt"># send it as is.</span>
+217: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
+218: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@discovered_hosts</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">direct_addressing</span> <span class="ruby-operator">&&</span> (<span class="ruby-ivar">@discovered_hosts</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator"><=</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">direct_addressing_threshold</span>)
+219: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">type</span> = <span class="ruby-identifier">:direct_request</span>
+220: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Handling #{requestid} as a direct request"</span>)
+221: <span class="ruby-keyword kw">end</span>
+222:
+223: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">'connector_plugin'</span>].<span class="ruby-identifier">publish</span>(<span class="ruby-keyword kw">self</span>)
+224: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="reply-to--method" class="method-detail ">
+ <a name="M000056"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">reply_to=</span><span
+ class="method-args">(target)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sets a custom reply-to target for requests. The connector plugin should
+inspect this when constructing requests and set this header ensuring
+replies will go to the custom target otherwise the connector should just do
+what it usually does
+</p>
+
+
+
+ <div class="method-source-code"
+ id="reply-to--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 99</span>
+ 99: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reply_to=</span>(<span class="ruby-identifier">target</span>)
+100: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Custom reply targets can only be set on requests"</span> <span class="ruby-keyword kw">unless</span> [<span class="ruby-identifier">:request</span>, <span class="ruby-identifier">:direct_request</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@type</span>)
+101:
+102: <span class="ruby-ivar">@reply_to</span> = <span class="ruby-identifier">target</span>
+103: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="type--method" class="method-detail ">
+ <a name="M000055"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">type=</span><span
+ class="method-args">(type)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sets the message type to one of the known types. In the case of
+:direct_request the list of hosts to communicate with should have been set
+with <a href="Message.html#discovered_hosts">discovered_hosts</a> else an
+exception will be raised. This is for extra security, we never accidentally
+want to send a direct request without a list of hosts or something weird
+like that as it might result in a filterless broadcast being sent.
+</p>
+<p>
+Additionally you simply cannot set :direct_request if direct_addressing was
+not enabled this is to force a workflow that doesnt not yield in a mistake
+when someone might assume direct_addressing is enabled when its not.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="type--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 76</span>
+76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">type=</span>(<span class="ruby-identifier">type</span>)
+77: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Unknown message type #{type}"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">VALIDTYPES</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">type</span>)
+78:
+79: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:direct_request</span>
+80: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Direct requests is not enabled using the direct_addressing config option"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">direct_addressing</span>
+81:
+82: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@discovered_hosts</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@discovered_hosts</span>.<span class="ruby-identifier">empty?</span>
+83: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Can only set type to :direct_request if discovered_hosts have been set"</span>
+84: <span class="ruby-keyword kw">end</span>
+85:
+86: <span class="ruby-comment cmt"># clear out the filter, custom discovery sources might interpret the filters</span>
+87: <span class="ruby-comment cmt"># different than the remote mcollectived and in directed mode really the only</span>
+88: <span class="ruby-comment cmt"># filter that matters is the agent filter</span>
+89: <span class="ruby-ivar">@filter</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter</span>
+90: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"agent"</span>] <span class="ruby-operator"><<</span> <span class="ruby-ivar">@agent</span>
+91: <span class="ruby-keyword kw">end</span>
+92:
+93: <span class="ruby-ivar">@type</span> = <span class="ruby-identifier">type</span>
+94: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-method" class="method-detail ">
+ <a name="M000066"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Perform validation against the message by checking filters and ttl
+</p>
+
+
+
+ <div class="method-source-code"
+ id="validate-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 190</span>
+190: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate</span>
+191: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Can only validate request messages"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:request</span>
+192:
+193: <span class="ruby-identifier">msg_age</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">utc</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">msgtime</span>
+194:
+195: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">msg_age</span> <span class="ruby-operator">></span> <span class="ruby-identifier">ttl</span>
+196: <span class="ruby-identifier">cid</span> = <span class="ruby-value str">""</span>
+197: <span class="ruby-identifier">cid</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:callerid</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">"@"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:callerid</span>)
+198: <span class="ruby-identifier">cid</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:senderid</span>]
+199:
+200: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">msg_age</span> <span class="ruby-operator">></span> <span class="ruby-identifier">ttl</span>
+201: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"global_stats"</span>].<span class="ruby-identifier">ttlexpired</span>
+202:
+203: <span class="ruby-identifier">raise</span>(<span class="ruby-constant">MsgTTLExpired</span>, <span class="ruby-node">"message #{requestid} from #{cid} created at #{msgtime} is #{msg_age} seconds old, TTL is #{ttl}"</span>)
+204: <span class="ruby-keyword kw">end</span>
+205: <span class="ruby-keyword kw">end</span>
+206:
+207: <span class="ruby-identifier">raise</span>(<span class="ruby-constant">NotTargettedAtUs</span>, <span class="ruby-value str">"Received message is not targetted to us"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>].<span class="ruby-identifier">validate_filter?</span>(<span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:filter</span>])
+208:
+209: <span class="ruby-ivar">@validated</span> = <span class="ruby-keyword kw">true</span>
+210: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-compound-filter-method" class="method-detail ">
+ <a name="M000063"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate_compound_filter</span><span
+ class="method-args">(compound_filter)</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="validate-compound-filter-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 151</span>
+151: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_compound_filter</span>(<span class="ruby-identifier">compound_filter</span>)
+152: <span class="ruby-identifier">compound_filter</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">filter</span><span class="ruby-operator">|</span>
+153: <span class="ruby-identifier">filter</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">statement</span><span class="ruby-operator">|</span>
+154: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>]
+155: <span class="ruby-identifier">functionname</span> = <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>][<span class="ruby-value str">"name"</span>]
+156: <span class="ruby-identifier">pluginname</span> = <span class="ruby-constant">Data</span>.<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">functionname</span>)
+157: <span class="ruby-identifier">value</span> = <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>][<span class="ruby-value str">"value"</span>]
+158:
+159: <span class="ruby-identifier">ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pluginname</span>, <span class="ruby-identifier">:data</span>)
+160:
+161: <span class="ruby-comment cmt"># parses numbers and booleans entered as strings into proper</span>
+162: <span class="ruby-comment cmt"># types of data so that DDL validation will pass</span>
+163: <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>][<span class="ruby-value str">"params"</span>] = <span class="ruby-constant">Data</span>.<span class="ruby-identifier">ddl_transform_input</span>(<span class="ruby-identifier">ddl</span>, <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>][<span class="ruby-value str">"params"</span>])
+164:
+165: <span class="ruby-constant">Data</span>.<span class="ruby-identifier">ddl_validate</span>(<span class="ruby-identifier">ddl</span>, <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>][<span class="ruby-value str">"params"</span>])
+166:
+167: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">Data</span>.<span class="ruby-identifier">ddl_has_output?</span>(<span class="ruby-identifier">ddl</span>, <span class="ruby-identifier">value</span>)
+168: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC41</span>, <span class="ruby-value str">"Data plugin '%{functionname}()' does not return a '%{value}' value"</span>, <span class="ruby-identifier">:error</span>, {<span class="ruby-identifier">:functionname</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">functionname</span>, <span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">value</span>})
+169: <span class="ruby-keyword kw">end</span>
+170: <span class="ruby-keyword kw">end</span>
+171: <span class="ruby-keyword kw">end</span>
+172: <span class="ruby-keyword kw">end</span>
+173: <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>
+
--- /dev/null
+<?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::MissingRPCData</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">RPCError</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::MissingRPCData</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::MsgDoesNotMatchRequestID</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">RuntimeError</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::MsgDoesNotMatchRequestID</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::MsgTTLExpired</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">RuntimeError</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::MsgTTLExpired</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::NotTargettedAtUs</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">RuntimeError</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::NotTargettedAtUs</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>Class: MCollective::Optionparser</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Optionparser</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/optionparser_rb.html">
- lib/mcollective/optionparser.rb
- </a>
- <br />
- </td>
- </tr>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
+ <title>Class: MCollective::Optionparser</title>
- <div id="bodyContent">
+ <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>
-
- <div id="contextContent">
-
- <div id="description">
- <p>
+</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/optionparser_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/optionparser.rb">lib/mcollective/optionparser.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="#M000020">::new</a></li>
+
+ <li><a href="#M000031">#add_common_options</a></li>
+
+ <li><a href="#M000024">#add_filter_options</a></li>
+
+ <li><a href="#M000028">#add_required_options</a></li>
+
+ <li><a href="#M000021">#parse</a></li>
+
+ <li><a href="#M000032">#parse_fact</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::Optionparser</h1>
+
+ <div id="description">
+ <p>
A simple helper to build cli tools that supports a uniform command line
layout.
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000455">add_common_options</a>
- <a href="#M000453">add_filter_options</a>
- <a href="#M000454">add_required_options</a>
- <a href="#M000451">new</a>
- <a href="#M000452">parse</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">parser</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000451" class="method-detail">
- <a name="M000451"></a>
-
- <div class="method-heading">
- <a href="#M000451" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(defaults = {}, include_sections = nil, exclude_sections = nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates a <a href="Optionparser.html#M000451">new</a> instance of the
-parser, you can supply defaults and include named groups of options.
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="parser-attribute-method" class="method-detail">
+ <a name="parser"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">parser</span><span
+ class="attribute-access-type">[R]</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="M000020"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(defaults = {}, include_sections = nil, exclude_sections = nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates a new instance of the parser, you can supply defaults and include
+named groups of options.
</p>
<p>
Starts a parser that defaults to verbose and that includs the filter
<pre>
oparser = MCollective::Optionparser.new({:verbose => true}, "filter", "common")
</pre>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000451-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000451-source">
+
+
+
+ <div class="method-source-code"
+ id="new-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/optionparser.rb, line 20</span>
20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">defaults</span> = {}, <span class="ruby-identifier">include_sections</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">exclude_sections</span> = <span class="ruby-keyword kw">nil</span>)
26: <span class="ruby-ivar">@options</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">default_options</span>
27:
28: <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">defaults</span>)
-29: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000455" class="method-detail">
- <a name="M000455"></a>
-
- <div class="method-heading">
- <a href="#M000455" class="method-signature">
- <span class="method-name">add_common_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+29: <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="add-common-options-method" class="method-detail ">
+ <a name="M000031"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">add_common_options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
These options will be added to most cli tools
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000455-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000455-source">
+
+
+
+ <div class="method-source-code"
+ id="add-common-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/optionparser.rb, line 128</span>
128: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_common_options</span>
177: <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"--threaded"</span>, <span class="ruby-value str">"Start publishing requests and receiving responses in threaded mode."</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
178: <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:threaded</span>] = <span class="ruby-keyword kw">true</span>
179: <span class="ruby-keyword kw">end</span>
-180: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000453" class="method-detail">
- <a name="M000453"></a>
-
- <div class="method-heading">
- <a href="#M000453" class="method-signature">
- <span class="method-name">add_filter_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+180: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="add-filter-options-method" class="method-detail ">
+ <a name="M000024"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">add_filter_options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
These options will be added if you pass ‘filter’ into the
include list of the constructor.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000453-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000453-source">
+
+
+
+ <div class="method-source-code"
+ id="add-filter-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/optionparser.rb, line 73</span>
73: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_filter_options</span>
106: <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-I'</span>, <span class="ruby-value str">'--wi'</span>, <span class="ruby-value str">'--with-identity IDENT'</span>, <span class="ruby-value str">'Match hosts with a certain configured identity'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span>
107: <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:filter</span>][<span class="ruby-value str">"identity"</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">a</span>
108: <span class="ruby-keyword kw">end</span>
-109: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000454" class="method-detail">
- <a name="M000454"></a>
-
- <div class="method-heading">
- <a href="#M000454" class="method-signature">
- <span class="method-name">add_required_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+109: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="add-required-options-method" class="method-detail ">
+ <a name="M000028"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">add_required_options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
These options should always be present
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000454-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000454-source">
+
+
+
+ <div class="method-source-code"
+ id="add-required-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/optionparser.rb, line 112</span>
112: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_required_options</span>
122: <span class="ruby-identifier">puts</span> <span class="ruby-ivar">@parser</span>
123: <span class="ruby-identifier">exit!</span> <span class="ruby-value">1</span>
124: <span class="ruby-keyword kw">end</span>
-125: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000452" class="method-detail">
- <a name="M000452"></a>
-
- <div class="method-heading">
- <a href="#M000452" class="method-signature">
- <span class="method-name">parse</span><span class="method-args">() {|@parser, @options| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+125: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="parse-method" class="method-detail ">
+ <a name="M000021"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">parse</span><span
+ class="method-args">(&block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Parse the options returning the options, you can pass a block that adds
additional options to the <a href="Optionparser.html">Optionparser</a>.
</p>
Users can set default options that get parsed in using the
MCOLLECTIVE_EXTRA_OPTS environemnt variable
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000452-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000452-source">
+
+
+
+ <div class="method-source-code"
+ id="parse-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/optionparser.rb, line 48</span>
48: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
66: <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:collective</span>] = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">main_collective</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:collective</span>]
67:
68: <span class="ruby-ivar">@options</span>
-69: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+69: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+ <div id="private-instance-method-details" class="method-section section">
+ <h3 class="section-header">Private Instance Methods</h3>
+
+
+ <div id="parse-fact-method" class="method-detail ">
+ <a name="M000032"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">parse_fact</span><span
+ class="method-args">(fact)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Parse a fact filter string like foo=bar into the tuple hash thats needed
+</p>
+
+
+ <div class="method-source-code"
+ id="parse-fact-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/optionparser.rb, line 184</span>
+184: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse_fact</span>(<span class="ruby-identifier">fact</span>)
+185: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">parse_fact_string</span>(<span class="ruby-identifier">fact</span>)
+186: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
- </div>
+
+ </div>
+
+ </div>
+
- </div>
+ </div>
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</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>
\ No newline at end of file
+</html>
+
--- /dev/null
+<?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>Module: MCollective::PluginManager</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="module">
+
+ <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/pluginmanager_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/pluginmanager.rb">lib/mcollective/pluginmanager.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000073">::<<</a></li>
+
+ <li><a href="#M000080">::[]</a></li>
+
+ <li><a href="#M000079">::clear</a></li>
+
+ <li><a href="#M000081">::create_instance</a></li>
+
+ <li><a href="#M000074">::delete</a></li>
+
+ <li><a href="#M000082">::find</a></li>
+
+ <li><a href="#M000083">::find_and_load</a></li>
+
+ <li><a href="#M000085">::grep</a></li>
+
+ <li><a href="#M000075">::include?</a></li>
+
+ <li><a href="#M000084">::loadclass</a></li>
+
+ <li><a href="#M000076">::pluginlist</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="module">MCollective::PluginManager</h1>
+
+ <div id="description">
+ <p>
+A simple plugin manager, it stores one plugin each of a specific type the
+idea is that we can only have one security provider, one connector etc.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000073"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name"><<</span><span
+ class="method-args">(plugin)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Adds a plugin to the list of plugins, we expect a hash like:
+</p>
+<pre>
+ {:type => "base",
+ :class => foo.new}
+</pre>
+<p>
+or like:
+</p>
+<pre>
+ {:type => "base",
+ :class => "Foo::Bar"}
+</pre>
+<p>
+In the event that we already have a class with the given type an exception
+will be raised.
+</p>
+<p>
+If the :class passed is a <a href="../String.html">String</a> then we will
+delay instantiation till the first time someone asks for the plugin, this
+is because most likely the registration gets done by inherited() hooks, at
+which point the plugin class is not final.
+</p>
+<p>
+If we were to do a .new here the Class initialize method would get called
+and not the plugins, we there for only initialize the classes when they get
+requested via []
+</p>
+<p>
+By default all plugin instances are cached and returned later so
+there’s always a single instance. You can pass :single_instance =>
+false when calling this to instruct it to always return a new instance when
+a copy is requested. This only works with sending a <a
+href="../String.html">String</a> for :class.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 30</span>
+30: <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>)
+31: <span class="ruby-identifier">plugin</span>[<span class="ruby-identifier">:single_instance</span>] = <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:single_instance</span>)
+32:
+33: <span class="ruby-identifier">type</span> = <span class="ruby-identifier">plugin</span>[<span class="ruby-identifier">:type</span>]
+34: <span class="ruby-identifier">klass</span> = <span class="ruby-identifier">plugin</span>[<span class="ruby-identifier">:class</span>]
+35: <span class="ruby-identifier">single</span> = <span class="ruby-identifier">plugin</span>[<span class="ruby-identifier">:single_instance</span>]
+36:
+37: <span class="ruby-identifier">raise</span>(<span class="ruby-node">"Plugin #{type} already loaded"</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">type</span>)
+38:
+39:
+40: <span class="ruby-comment cmt"># If we get a string then store 'nil' as the instance, signalling that we'll</span>
+41: <span class="ruby-comment cmt"># create the class later on demand.</span>
+42: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
+43: <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">type</span>] = {<span class="ruby-identifier">:loadtime</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>, <span class="ruby-identifier">:instance</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">:single</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">single</span>}
+44: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Registering plugin #{type} with class #{klass} single_instance: #{single}"</span>)
+45: <span class="ruby-keyword kw">else</span>
+46: <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">type</span>] = {<span class="ruby-identifier">:loadtime</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">:instance</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>, <span class="ruby-identifier">:single</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>}
+47: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Registering plugin #{type} with class #{klass.class} single_instance: true"</span>)
+48: <span class="ruby-keyword kw">end</span>
+49: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000080"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(plugin)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Gets a plugin by type
+</p>
+
+
+
+ <div class="method-source-code"
+ id="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 72</span>
+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>)
+73: <span class="ruby-identifier">raise</span>(<span class="ruby-node">"No plugin #{plugin} defined"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">plugin</span>)
+74:
+75: <span class="ruby-identifier">klass</span> = <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">plugin</span>][<span class="ruby-identifier">:class</span>]
+76:
+77: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">plugin</span>][<span class="ruby-identifier">:single</span>]
+78: <span class="ruby-comment cmt"># Create an instance of the class if one hasn't been done before</span>
+79: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">plugin</span>][<span class="ruby-identifier">:instance</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
+80: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Returning new plugin #{plugin} with class #{klass}"</span>)
+81: <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">plugin</span>][<span class="ruby-identifier">:instance</span>] = <span class="ruby-identifier">create_instance</span>(<span class="ruby-identifier">klass</span>)
+82: <span class="ruby-keyword kw">else</span>
+83: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Returning cached plugin #{plugin} with class #{klass}"</span>)
+84: <span class="ruby-keyword kw">end</span>
+85:
+86: <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">plugin</span>][<span class="ruby-identifier">:instance</span>]
+87: <span class="ruby-keyword kw">else</span>
+88: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Returning new plugin #{plugin} with class #{klass}"</span>)
+89: <span class="ruby-identifier">create_instance</span>(<span class="ruby-identifier">klass</span>)
+90: <span class="ruby-keyword kw">end</span>
+91: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="clear-method" class="method-detail ">
+ <a name="M000079"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">clear</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+deletes all registered plugins
+</p>
+
+
+
+ <div class="method-source-code"
+ id="clear-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 67</span>
+67: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">clear</span>
+68: <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">clear</span>
+69: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="create-instance-method" class="method-detail ">
+ <a name="M000081"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">create_instance</span><span
+ class="method-args">(klass)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+use eval to create an instance of a class
+</p>
+
+
+
+ <div class="method-source-code"
+ id="create-instance-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 94</span>
+ 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>)
+ 95: <span class="ruby-keyword kw">begin</span>
+ 96: <span class="ruby-identifier">eval</span>(<span class="ruby-node">"#{klass}.new"</span>)
+ 97: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+ 98: <span class="ruby-identifier">raise</span>(<span class="ruby-node">"Could not create instance of plugin #{klass}: #{e}"</span>)
+ 99: <span class="ruby-keyword kw">end</span>
+100: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="delete-method" class="method-detail ">
+ <a name="M000074"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">delete</span><span
+ class="method-args">(plugin)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Removes a plugim the list
+</p>
+
+
+
+ <div class="method-source-code"
+ id="delete-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 52</span>
+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>)
+53: <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">plugin</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">plugin</span>)
+54: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="find-method" class="method-detail ">
+ <a name="M000082"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">find</span><span
+ class="method-args">(type, extension="rb")</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Finds plugins in all configured libdirs
+</p>
+<pre>
+ find("agent")
+</pre>
+<p>
+will return an array of just agent names, for example:
+</p>
+<pre>
+ ["puppetd", "package"]
+</pre>
+<p>
+Can also be used to find files of other extensions:
+</p>
+<pre>
+ find("agent", "ddl")
+</pre>
+<p>
+Will return the same list but only of files with extension .ddl in the
+agent subdirectory
+</p>
+
+
+
+ <div class="method-source-code"
+ id="find-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 116</span>
+116: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">extension</span>=<span class="ruby-value str">"rb"</span>)
+117: <span class="ruby-identifier">extension</span> = <span class="ruby-node">".#{extension}"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">extension</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^\./</span>)
+118:
+119: <span class="ruby-identifier">plugins</span> = []
+120:
+121: <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">libdir</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">libdir</span><span class="ruby-operator">|</span>
+122: <span class="ruby-identifier">plugdir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>([<span class="ruby-identifier">libdir</span>, <span class="ruby-value str">"mcollective"</span>, <span class="ruby-identifier">type</span>.<span class="ruby-identifier">to_s</span>])
+123: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">plugdir</span>)
+124:
+125: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">plugdir</span>).<span class="ruby-identifier">grep</span>(<span class="ruby-node">/#{extension}$/</span>).<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">plugin</span><span class="ruby-operator">|</span>
+126: <span class="ruby-identifier">plugins</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">plugin</span>, <span class="ruby-identifier">extension</span>)
+127: <span class="ruby-keyword kw">end</span>
+128: <span class="ruby-keyword kw">end</span>
+129:
+130: <span class="ruby-identifier">plugins</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">uniq</span>
+131: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="find-and-load-method" class="method-detail ">
+ <a name="M000083"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">find_and_load</span><span
+ class="method-args">(type, extension="rb")</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Finds and loads from disk all plugins from all libdirs that match certain
+criteria.
+</p>
+<pre>
+ find_and_load("pluginpackager")
+</pre>
+<p>
+Will find all .rb files in the libdir/mcollective/pluginpackager/ directory
+in all libdirs and load them from disk.
+</p>
+<p>
+You can influence what plugins get loaded using a block notation:
+</p>
+<pre>
+ find_and_load("pluginpackager") do |plugin|
+ plugin.match(/puppet/)
+ end
+</pre>
+<p>
+This will load only plugins matching /puppet/
+</p>
+
+
+
+ <div class="method-source-code"
+ id="find-and-load-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 148</span>
+148: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">find_and_load</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">extension</span>=<span class="ruby-value str">"rb"</span>)
+149: <span class="ruby-identifier">extension</span> = <span class="ruby-node">".#{extension}"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">extension</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^\./</span>)
+150:
+151: <span class="ruby-identifier">klasses</span> = <span class="ruby-identifier">find</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">extension</span>).<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">plugin</span><span class="ruby-operator">|</span>
+152: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+153: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">plugin</span>)
+154: <span class="ruby-keyword kw">end</span>
+155:
+156: <span class="ruby-value str">"%s::%s::%s"</span> <span class="ruby-operator">%</span> [ <span class="ruby-value str">"MCollective"</span>, <span class="ruby-identifier">type</span>.<span class="ruby-identifier">capitalize</span>, <span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">capitalize</span> ]
+157: <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">compact</span>
+158:
+159: <span class="ruby-identifier">klasses</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">uniq</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">klass</span><span class="ruby-operator">|</span> <span class="ruby-identifier">loadclass</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-keyword kw">true</span>)}
+160: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="grep-method" class="method-detail ">
+ <a name="M000085"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">grep</span><span
+ class="method-args">(regex)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Grep’s over the plugin list and returns the list found
+</p>
+
+
+
+ <div class="method-source-code"
+ id="grep-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 176</span>
+176: <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>)
+177: <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-identifier">regex</span>)
+178: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="include--method" class="method-detail ">
+ <a name="M000075"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">include?</span><span
+ class="method-args">(plugin)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Finds out if we have a plugin with the given name
+</p>
+
+
+
+ <div class="method-source-code"
+ id="include--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 57</span>
+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>)
+58: <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">plugin</span>)
+59: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="loadclass-method" class="method-detail ">
+ <a name="M000084"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">loadclass</span><span
+ class="method-args">(klass, squash_failures=false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Loads a class from file by doing some simple search/replace on class names
+and then doing a require.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="loadclass-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 164</span>
+164: <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>, <span class="ruby-identifier">squash_failures</span>=<span class="ruby-keyword kw">false</span>)
+165: <span class="ruby-identifier">fname</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">"::"</span>, <span class="ruby-value str">"/"</span>).<span class="ruby-identifier">downcase</span> <span class="ruby-operator">+</span> <span class="ruby-value str">".rb"</span>
+166:
+167: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Loading #{klass} from #{fname}"</span>)
+168:
+169: <span class="ruby-identifier">load</span> <span class="ruby-identifier">fname</span>
+170: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+171: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Failed to load #{klass}: #{e}"</span>)
+172: <span class="ruby-identifier">raise</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">squash_failures</span>
+173: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="pluginlist-method" class="method-detail ">
+ <a name="M000076"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">pluginlist</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Provides a list of plugins we know about
+</p>
+
+
+
+ <div class="method-source-code"
+ id="pluginlist-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 62</span>
+62: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">pluginlist</span>
+63: <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">sort</span>
+64: <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>
+
--- /dev/null
+<?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>Module: MCollective::PluginPackager</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="module">
+
+ <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_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/pluginpackager.rb">lib/mcollective/pluginpackager.rb</a></li>
+
+ <li><a href="../lib/mcollective/pluginpackager/standard_definition_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/pluginpackager/standard_definition.rb">lib/mcollective/pluginpackager/standard_definition.rb</a></li>
+
+ <li><a href="../lib/mcollective/pluginpackager/agent_definition_rb.html?TB_iframe=true&height=550&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 -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
+
+ <li><span class="type">CLASS</span> <a href="PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000034">::[]</a></li>
+
+ <li><a href="#M000036">::check_dir_present</a></li>
+
+ <li><a href="#M000038">::command_available?</a></li>
+
+ <li><a href="#M000037">::execute_verbosely</a></li>
+
+ <li><a href="#M000040">::filter_dependencies</a></li>
+
+ <li><a href="#M000035">::get_metadata</a></li>
+
+ <li><a href="#M000033">::load_packagers</a></li>
+
+ <li><a href="#M000039">::safe_system</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="module">MCollective::PluginPackager</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000034"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(klass)</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="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 12</span>
+12: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">klass</span>)
+13: <span class="ruby-identifier">const_get</span>(<span class="ruby-node">"#{klass}"</span>)
+14: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="check-dir-present-method" class="method-detail ">
+ <a name="M000036"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">check_dir_present</span><span
+ class="method-args">(path)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Checks if a directory is present and not empty
+</p>
+
+
+
+ <div class="method-source-code"
+ id="check-dir-present-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 31</span>
+31: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">check_dir_present</span>(<span class="ruby-identifier">path</span>)
+32: (<span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">path</span>) <span class="ruby-operator">&&</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">path</span>, <span class="ruby-value str">"*"</span>)).<span class="ruby-identifier">empty?</span>)
+33: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="command-available--method" class="method-detail ">
+ <a name="M000038"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">command_available?</span><span
+ class="method-args">(build_tool)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Checks if a build tool is present on the system
+</p>
+
+
+
+ <div class="method-source-code"
+ id="command-available--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 54</span>
+54: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">command_available?</span>(<span class="ruby-identifier">build_tool</span>)
+55: <span class="ruby-constant">ENV</span>[<span class="ruby-value str">"PATH"</span>].<span class="ruby-identifier">split</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">PATH_SEPARATOR</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
+56: <span class="ruby-identifier">builder</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">build_tool</span>)
+57: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">builder</span>)
+58: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+59: <span class="ruby-keyword kw">end</span>
+60: <span class="ruby-keyword kw">end</span>
+61: <span class="ruby-keyword kw">false</span>
+62: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="execute-verbosely-method" class="method-detail ">
+ <a name="M000037"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">execute_verbosely</span><span
+ class="method-args">(verbose, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Quietly calls a block if verbose parameter is false
+</p>
+
+
+
+ <div class="method-source-code"
+ id="execute-verbosely-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 36</span>
+36: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">execute_verbosely</span>(<span class="ruby-identifier">verbose</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+37: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">verbose</span>
+38: <span class="ruby-identifier">old_stdout</span> = <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">clone</span>
+39: <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">"/dev/null"</span>, <span class="ruby-value str">"w"</span>))
+40: <span class="ruby-keyword kw">begin</span>
+41: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>
+42: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+43: <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">reopen</span> <span class="ruby-identifier">old_stdout</span>
+44: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
+45: <span class="ruby-keyword kw">ensure</span>
+46: <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">reopen</span> <span class="ruby-identifier">old_stdout</span>
+47: <span class="ruby-keyword kw">end</span>
+48: <span class="ruby-keyword kw">else</span>
+49: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>
+50: <span class="ruby-keyword kw">end</span>
+51: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="filter-dependencies-method" class="method-detail ">
+ <a name="M000040"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">filter_dependencies</span><span
+ class="method-args">(prefix, dependencies)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Filter out platform specific dependencies Given a list of dependencies
+named - debian::foo redhat::bar <a
+href="PluginPackager.html#M000040">PluginPackager.filter_dependencies</a>(‘debian’,
+dependencies) will return foo.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="filter-dependencies-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 74</span>
+74: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">filter_dependencies</span>(<span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">dependencies</span>)
+75: <span class="ruby-identifier">dependencies</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dependency</span><span class="ruby-operator">|</span>
+76: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-identifier">:name</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^(\w+)::(\w+)/</span>
+77: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">prefix</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">$1</span>
+78: <span class="ruby-identifier">dependency</span>[<span class="ruby-identifier">:name</span>] = <span class="ruby-identifier">$2</span>
+79: <span class="ruby-identifier">dependency</span>
+80: <span class="ruby-keyword kw">else</span>
+81: <span class="ruby-keyword kw">nil</span>
+82: <span class="ruby-keyword kw">end</span>
+83: <span class="ruby-keyword kw">else</span>
+84: <span class="ruby-identifier">dependency</span>
+85: <span class="ruby-keyword kw">end</span>
+86: <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">reject</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">dependency</span><span class="ruby-operator">|</span> <span class="ruby-identifier">dependency</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span> }
+87: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="get-metadata-method" class="method-detail ">
+ <a name="M000035"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">get_metadata</span><span
+ class="method-args">(path, type)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Fetch and return metadata from plugin <a href="DDL.html">DDL</a>
+</p>
+
+
+
+ <div class="method-source-code"
+ id="get-metadata-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 17</span>
+17: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_metadata</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">type</span>)
+18: <span class="ruby-identifier">ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">"package"</span>, <span class="ruby-identifier">type</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-keyword kw">false</span>)
+19:
+20: <span class="ruby-keyword kw">begin</span>
+21: <span class="ruby-identifier">ddl_file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</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">path</span>, <span class="ruby-identifier">type</span>, <span class="ruby-value str">"*.ddl"</span>)).<span class="ruby-identifier">first</span>)
+22: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span>
+23: <span class="ruby-identifier">raise</span> <span class="ruby-node">"failed to load ddl file in plugin directory : #{File.join(path, type)}"</span>
+24: <span class="ruby-keyword kw">end</span>
+25: <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">instance_eval</span> <span class="ruby-identifier">ddl_file</span>
+26:
+27: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">meta</span>, <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">requirements</span>[<span class="ruby-identifier">:mcollective</span>]
+28: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="load-packagers-method" class="method-detail ">
+ <a name="M000033"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_packagers</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Package implementation plugins
+</p>
+
+
+
+ <div class="method-source-code"
+ id="load-packagers-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 8</span>
+ 8: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_packagers</span>
+ 9: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find_and_load</span>(<span class="ruby-value str">"pluginpackager"</span>)
+10: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="safe-system-method" class="method-detail ">
+ <a name="M000039"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">safe_system</span><span
+ class="method-args">(*args)</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="safe-system-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 64</span>
+64: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">safe_system</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+65: <span class="ruby-identifier">raise</span>(<span class="ruby-constant">RuntimeError</span>, <span class="ruby-node">"Failed: #{args.join(' ')}"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">system</span> <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>
+66: <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>
+
--- /dev/null
+<?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&height=550&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">"Puppet Labs"</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">"agent"</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">"mcollective"</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"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{@mcname}-common"</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@mcversion</span>}
+23: <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:name</span>] = (<span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:pluginname</span>] <span class="ruby-operator">||</span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:name</span>]).<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/\s+|_/</span>, <span class="ruby-value str">"-"</span>)
+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">></span> [],
+40: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
+41: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"Agent plugin for #{@metadata[:name]}"</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">"agent"</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">"*.ddl"</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">"*"</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">></span> <span class="ruby-node">"#{@mcname}-#{@metadata[:name]}-common"</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>], <span class="ruby-identifier">:revision</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@revision</span>}
+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">></span> [],
+58: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
+59: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"Client plugin for #{@metadata[:name]}"</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">"application"</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">"aggregate"</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">"*"</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">"*"</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">></span> <span class="ruby-node">"#{@mcname}-#{@metadata[:name]}-common"</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>], <span class="ruby-identifier">:revision</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@revision</span>}
+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">></span>[],
+73: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
+74: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"Common libraries for #{@metadata[:name]}"</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">"data"</span>, <span class="ruby-value str">"**"</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">"util"</span>, <span class="ruby-value str">"**"</span>, <span class="ruby-value str">"**"</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">"agent"</span>, <span class="ruby-value str">"*.ddl"</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">"validator"</span>, <span class="ruby-value str">"**"</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">"cannot create package - No ddl file found in #{File.join(@path, "agent")}"</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>
+
--- /dev/null
+<?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::StandardDefinition</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/standard_definition_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/pluginpackager/standard_definition.rb">lib/mcollective/pluginpackager/standard_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="#M000086">::new</a></li>
+
+ <li><a href="#M000089">#common</a></li>
+
+ <li><a href="#M000087">#identify_packages</a></li>
+
+ <li><a href="#M000088">#plugin</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::StandardDefinition</h1>
+
+ <div id="description">
+
+ </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="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="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="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="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="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="M000086"></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/standard_definition.rb, line 7</span>
+ 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>)
+ 8: <span class="ruby-ivar">@plugintype</span> = <span class="ruby-identifier">plugintype</span>
+ 9: <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:target</span>]
+10: <span class="ruby-ivar">@packagedata</span> = {}
+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>
+12: <span class="ruby-ivar">@preinstall</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:preinstall</span>]
+13: <span class="ruby-ivar">@postinstall</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:postinstall</span>]
+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">"Puppet Labs"</span>
+15: <span class="ruby-ivar">@dependencies</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:dependency</span>] <span class="ruby-operator">||</span> []
+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>)
+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>)
+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">"mcollective"</span>
+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>
+20: <span class="ruby-ivar">@dependencies</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{mcname}-common"</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@mcversion</span>}
+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">"-"</span>)
+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>])
+23: <span class="ruby-identifier">identify_packages</span>
+24: <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="common-method" class="method-detail ">
+ <a name="M000089"></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 list of common files
+</p>
+
+
+
+ <div class="method-source-code"
+ id="common-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/standard_definition.rb, line 54</span>
+54: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">common</span>
+55: <span class="ruby-identifier">common</span> = {<span class="ruby-identifier">:files</span> =<span class="ruby-operator">></span> [],
+56: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
+57: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"Common libraries for #{@name} connector plugin"</span>}
+58:
+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">"util"</span>)
+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>
+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">"*"</span>))
+62: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">common</span>
+63: <span class="ruby-keyword kw">else</span>
+64: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
+65: <span class="ruby-keyword kw">end</span>
+66: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="identify-packages-method" class="method-detail ">
+ <a name="M000087"></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 the packagedata hash
+</p>
+
+
+
+ <div class="method-source-code"
+ id="identify-packages-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/standard_definition.rb, line 27</span>
+27: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">identify_packages</span>
+28: <span class="ruby-identifier">common_package</span> = <span class="ruby-identifier">common</span>
+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>
+30: <span class="ruby-identifier">plugin_package</span> = <span class="ruby-identifier">plugin</span>
+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>
+32: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="plugin-method" class="method-detail ">
+ <a name="M000088"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">plugin</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Obtain standard plugin files and dependencies
+</p>
+
+
+
+ <div class="method-source-code"
+ id="plugin-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/standard_definition.rb, line 35</span>
+35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">plugin</span>
+36: <span class="ruby-identifier">plugindata</span> = {<span class="ruby-identifier">:files</span> =<span class="ruby-operator">></span> [],
+37: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
+38: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{@name} #{@plugintype} plugin for the Marionette Collective."</span>}
+39:
+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>)
+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>
+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">"*"</span>))
+43: <span class="ruby-keyword kw">else</span>
+44: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
+45: <span class="ruby-keyword kw">end</span>
+46:
+47: <span class="ruby-identifier">plugindata</span>[<span class="ruby-identifier">:plugindependency</span>] = {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{@mcname}-#{@metadata[:name]}-common"</span>,
+48: <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>],
+49: <span class="ruby-identifier">:revision</span> =<span class="ruby-operator">></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>]
+50: <span class="ruby-identifier">plugindata</span>
+51: <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>
+
--- /dev/null
+<?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>Module: MCollective::RPC</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="module">
+
+ <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/rpc_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc.rb">lib/mcollective/rpc.rb</a></li>
+
+ <li><a href="../lib/mcollective/rpc/actionrunner_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/actionrunner.rb">lib/mcollective/rpc/actionrunner.rb</a></li>
+
+ <li><a href="../lib/mcollective/rpc/reply_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/reply.rb">lib/mcollective/rpc/reply.rb</a></li>
+
+ <li><a href="../lib/mcollective/rpc/progress_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/progress.rb">lib/mcollective/rpc/progress.rb</a></li>
+
+ <li><a href="../lib/mcollective/rpc/agent_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/agent.rb">lib/mcollective/rpc/agent.rb</a></li>
+
+ <li><a href="../lib/mcollective/rpc/request_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/request.rb">lib/mcollective/rpc/request.rb</a></li>
+
+ <li><a href="../lib/mcollective/rpc/audit_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/audit.rb">lib/mcollective/rpc/audit.rb</a></li>
+
+ <li><a href="../lib/mcollective/rpc/stats_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/stats.rb">lib/mcollective/rpc/stats.rb</a></li>
+
+ <li><a href="../lib/mcollective/rpc/result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/result.rb">lib/mcollective/rpc/result.rb</a></li>
+
+ <li><a href="../lib/mcollective/rpc/helpers_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/helpers.rb">lib/mcollective/rpc/helpers.rb</a></li>
+
+ <li><a href="../lib/mcollective/rpc/client_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/client.rb">lib/mcollective/rpc/client.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
+
+ <li><span class="type">CLASS</span> <a href="RPC/Agent.html">MCollective::RPC::Agent</a></li>
+
+ <li><span class="type">CLASS</span> <a href="RPC/Audit.html">MCollective::RPC::Audit</a></li>
+
+ <li><span class="type">CLASS</span> <a href="RPC/Client.html">MCollective::RPC::Client</a></li>
+
+ <li><span class="type">CLASS</span> <a href="RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
+
+ <li><span class="type">CLASS</span> <a href="RPC/Progress.html">MCollective::RPC::Progress</a></li>
+
+ <li><span class="type">CLASS</span> <a href="RPC/Reply.html">MCollective::RPC::Reply</a></li>
+
+ <li><span class="type">CLASS</span> <a href="RPC/Request.html">MCollective::RPC::Request</a></li>
+
+ <li><span class="type">CLASS</span> <a href="RPC/Result.html">MCollective::RPC::Result</a></li>
+
+ <li><span class="type">CLASS</span> <a href="RPC/Stats.html">MCollective::RPC::Stats</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000327">::const_missing</a></li>
+
+ <li><a href="#M000320">::discovered</a></li>
+
+ <li><a href="#M000319">::stats</a></li>
+
+ <li><a href="#M000324">#empty_filter?</a></li>
+
+ <li><a href="#M000323">#printrpc</a></li>
+
+ <li><a href="#M000321">#printrpcstats</a></li>
+
+ <li><a href="#M000314">#rpcclient</a></li>
+
+ <li><a href="#M000310">#rpcoptions</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="module">MCollective::RPC</h1>
+
+ <div id="description">
+ <p>
+Toolset to create a standard interface of client and agent using an <a
+href="RPC.html">RPC</a> metaphor, standard compliant agents will make it
+easier to create generic clients like web interfaces etc
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="const-missing-method" class="method-detail ">
+ <a name="M000327"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">const_missing</span><span
+ class="method-args">(const_name)</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="const-missing-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 175</span>
+175: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">const_missing</span>(<span class="ruby-identifier">const_name</span>)
+176: <span class="ruby-keyword kw">super</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">const_name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:DDL</span>
+177:
+178: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-value str">"MCollective::RPC::DDL is deprecatd, please use MCollective::DDL instead"</span>)
+179: <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">DDL</span>
+180: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovered-method" class="method-detail ">
+ <a name="M000320"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovered</span><span
+ class="method-args">(discovered)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+means for other classes to drop discovered hosts into this module its a bit
+hacky but needed so that the mixin methods like printrpcstats can easily
+get access to it without users having to pass it around in params.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="discovered-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 107</span>
+107: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">discovered</span>(<span class="ruby-identifier">discovered</span>)
+108: <span class="ruby-ivar">@@discovered</span> = <span class="ruby-identifier">discovered</span>
+109: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="stats-method" class="method-detail ">
+ <a name="M000319"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">stats</span><span
+ class="method-args">(stats)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+means for other classes to drop stats into this module its a bit hacky but
+needed so that the mixin methods like printrpcstats can easily get access
+to it without users having to pass it around in params.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="stats-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 99</span>
+ 99: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">stats</span>(<span class="ruby-identifier">stats</span>)
+100: <span class="ruby-ivar">@@stats</span> = <span class="ruby-identifier">stats</span>
+101: <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="empty-filter--method" class="method-detail ">
+ <a name="M000324"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">empty_filter?</span><span
+ class="method-args">(options)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Wrapper for <a href="Util.html#M000300">MCollective::Util.empty_filter?</a>
+to make clients less fugly to write - ticket 18
+</p>
+
+
+
+ <div class="method-source-code"
+ id="empty-filter--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 167</span>
+167: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">empty_filter?</span>(<span class="ruby-identifier">options</span>)
+168: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:filter</span>)
+169: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter?</span>(<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:filter</span>])
+170: <span class="ruby-keyword kw">else</span>
+171: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter?</span>(<span class="ruby-identifier">options</span>)
+172: <span class="ruby-keyword kw">end</span>
+173: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="printrpc-method" class="method-detail ">
+ <a name="M000323"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">printrpc</span><span
+ class="method-args">(result, flags = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Prints the result of an <a href="RPC.html">RPC</a> call.
+</p>
+<p>
+In the default quiet mode - no flattening or verbose - only results that
+produce an error will be printed
+</p>
+<p>
+To get details of each result run with the -v command line option.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="printrpc-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 146</span>
+146: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">printrpc</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">flags</span> = {})
+147: <span class="ruby-identifier">verbose</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:verbose</span>] <span class="ruby-keyword kw">rescue</span> <span class="ruby-identifier">verbose</span> = <span class="ruby-keyword kw">false</span>
+148: <span class="ruby-identifier">verbose</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:verbose</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">verbose</span>
+149: <span class="ruby-identifier">flatten</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:flatten</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword kw">false</span>
+150: <span class="ruby-identifier">format</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:output_format</span>]
+151: <span class="ruby-identifier">forced_mode</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:force_display_mode</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword kw">false</span>
+152:
+153: <span class="ruby-identifier">result_text</span> = <span class="ruby-constant">Helpers</span>.<span class="ruby-identifier">rpcresults</span>(<span class="ruby-identifier">result</span>, {<span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">verbose</span>, <span class="ruby-identifier">:flatten</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">flatten</span>, <span class="ruby-identifier">:format</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">format</span>, <span class="ruby-identifier">:force_display_mode</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">forced_mode</span>})
+154:
+155: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">format</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:console</span>
+156: <span class="ruby-identifier">puts</span> <span class="ruby-value str">"\n%s\n"</span> <span class="ruby-operator">%</span> [ <span class="ruby-identifier">result_text</span> ]
+157: <span class="ruby-keyword kw">else</span>
+158: <span class="ruby-comment cmt"># when we get just one result to print dont pad them all with</span>
+159: <span class="ruby-comment cmt"># blank spaces etc, just print the individual result with no</span>
+160: <span class="ruby-comment cmt"># padding</span>
+161: <span class="ruby-identifier">puts</span> <span class="ruby-identifier">result_text</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">result_text</span> <span class="ruby-operator">==</span> <span class="ruby-value str">""</span>
+162: <span class="ruby-keyword kw">end</span>
+163: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="printrpcstats-method" class="method-detail ">
+ <a name="M000321"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">printrpcstats</span><span
+ class="method-args">(flags={})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Prints stats, requires stats to be saved from elsewhere using the <a
+href="RPC.html#M000319">MCollective::RPC.stats</a> method.
+</p>
+<p>
+If you’ve passed -v on the command line a detailed stat block will be
+printed, else just a one liner.
+</p>
+<p>
+You can pass flags into it:
+</p>
+<pre>
+ printrpcstats :caption => "Foo", :summarize => true
+</pre>
+<p>
+This will use “Foo” as the caption to the stats in verbose mode
+and print out any aggregate summary information if present
+</p>
+
+
+
+ <div class="method-source-code"
+ id="printrpcstats-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 123</span>
+123: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">printrpcstats</span>(<span class="ruby-identifier">flags</span>={})
+124: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:output_format</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">:console</span>
+125:
+126: <span class="ruby-identifier">flags</span> = {<span class="ruby-identifier">:summarize</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">:caption</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"rpc stats"</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">flags</span>)
+127:
+128: <span class="ruby-identifier">verbose</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:verbose</span>] <span class="ruby-keyword kw">rescue</span> <span class="ruby-identifier">verbose</span> = <span class="ruby-keyword kw">false</span>
+129:
+130: <span class="ruby-keyword kw">begin</span>
+131: <span class="ruby-identifier">stats</span> = <span class="ruby-ivar">@@stats</span>
+132: <span class="ruby-keyword kw">rescue</span>
+133: <span class="ruby-identifier">puts</span>(<span class="ruby-value str">"no stats to display"</span>)
+134: <span class="ruby-keyword kw">return</span>
+135: <span class="ruby-keyword kw">end</span>
+136:
+137: <span class="ruby-identifier">puts</span> <span class="ruby-identifier">stats</span>.<span class="ruby-identifier">report</span>(<span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:caption</span>], <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:summarize</span>], <span class="ruby-identifier">verbose</span>)
+138: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rpcclient-method" class="method-detail ">
+ <a name="M000314"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rpcclient</span><span
+ class="method-args">(agent, flags = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Wrapper to create clients, supposed to be used as a mixin:
+</p>
+<p>
+include <a href="RPC.html">MCollective::RPC</a>
+</p>
+<p>
+exim = rpcclient(“exim”) printrpc exim.mailq
+</p>
+<p>
+or
+</p>
+<p>
+rpcclient(“exim”) do |exim|
+</p>
+<pre>
+ printrpc exim.mailq
+</pre>
+<p>
+end
+</p>
+<p>
+It will take a few flags:
+</p>
+<pre>
+ :configfile => "etc/client.cfg"
+ :options => options
+ :exit_on_failure => true
+</pre>
+<p>
+Options would be a build up options hash from the <a
+href="Optionparser.html">Optionparser</a> you can use the rpcoptions helper
+to create this
+</p>
+<p>
+:exit_on_failure is true by default, and causes the application to exit if
+there is a failure constructing the <a href="RPC.html">RPC</a> client. Set
+this flag to false to cause an Exception to be raised instead.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="rpcclient-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 60</span>
+60: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rpcclient</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">flags</span> = {})
+61: <span class="ruby-identifier">configfile</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:configfile</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">"/etc/mcollective/client.cfg"</span>
+62: <span class="ruby-identifier">options</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:options</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword kw">nil</span>
+63:
+64: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">flags</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">:exit_on_failure</span>)
+65: <span class="ruby-identifier">exit_on_failure</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:exit_on_failure</span>]
+66: <span class="ruby-keyword kw">else</span>
+67: <span class="ruby-comment cmt"># We exit on failure by default for CLI-friendliness</span>
+68: <span class="ruby-identifier">exit_on_failure</span> = <span class="ruby-keyword kw">true</span>
+69: <span class="ruby-keyword kw">end</span>
+70:
+71: <span class="ruby-keyword kw">begin</span>
+72: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>
+73: <span class="ruby-identifier">rpc</span> = <span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:configfile</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:config</span>], <span class="ruby-identifier">:options</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span>)
+74: <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">rpc</span>.<span class="ruby-identifier">options</span>
+75: <span class="ruby-keyword kw">else</span>
+76: <span class="ruby-identifier">rpc</span> = <span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:configfile</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">configfile</span>)
+77: <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">rpc</span>.<span class="ruby-identifier">options</span>
+78: <span class="ruby-keyword kw">end</span>
+79: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+80: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">exit_on_failure</span>
+81: <span class="ruby-identifier">puts</span>(<span class="ruby-node">"Could not create RPC client: #{e}"</span>)
+82: <span class="ruby-identifier">exit!</span>
+83: <span class="ruby-keyword kw">else</span>
+84: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
+85: <span class="ruby-keyword kw">end</span>
+86: <span class="ruby-keyword kw">end</span>
+87:
+88: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+89: <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">rpc</span>)
+90: <span class="ruby-keyword kw">else</span>
+91: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">rpc</span>
+92: <span class="ruby-keyword kw">end</span>
+93: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rpcoptions-method" class="method-detail ">
+ <a name="M000310"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rpcoptions</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates a standard options hash, pass in a block to add extra headings etc
+see <a href="Optionparser.html">Optionparser</a>
+</p>
+
+
+
+ <div class="method-source-code"
+ id="rpcoptions-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 21</span>
+21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rpcoptions</span>
+22: <span class="ruby-identifier">oparser</span> = <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">Optionparser</span>.<span class="ruby-identifier">new</span>({<span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">:progress_bar</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>}, <span class="ruby-value str">"filter"</span>)
+23:
+24: <span class="ruby-identifier">options</span> = <span class="ruby-identifier">oparser</span>.<span class="ruby-identifier">parse</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">parser</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
+25: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+26: <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">parser</span>, <span class="ruby-identifier">options</span>)
+27: <span class="ruby-keyword kw">end</span>
+28:
+29: <span class="ruby-constant">Helpers</span>.<span class="ruby-identifier">add_simplerpc_options</span>(<span class="ruby-identifier">parser</span>, <span class="ruby-identifier">options</span>)
+30: <span class="ruby-keyword kw">end</span>
+31:
+32: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">options</span>
+33: <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>
+
--- /dev/null
+<?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::RPC::ActionRunner</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/rpc/actionrunner_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/actionrunner.rb">lib/mcollective/rpc/actionrunner.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="#M000372">::new</a></li>
+
+ <li><a href="#M000379">#canrun?</a></li>
+
+ <li><a href="#M000376">#load_json_results</a></li>
+
+ <li><a href="#M000375">#load_results</a></li>
+
+ <li><a href="#M000382">#path_to_command</a></li>
+
+ <li><a href="#M000373">#run</a></li>
+
+ <li><a href="#M000378">#save_json_request</a></li>
+
+ <li><a href="#M000377">#saverequest</a></li>
+
+ <li><a href="#M000374">#shell</a></li>
+
+ <li><a href="#M000381">#tempfile</a></li>
+
+ <li><a href="#M000380">#to_s</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::RPC::ActionRunner</h1>
+
+ <div id="description">
+ <p>
+A helper used by <a href="Agent.html#M000415">RPC::Agent#implemented_by</a>
+to delegate an action to an external script. At present only JSON based
+serialization is supported in future ones based on key=val pairs etc will
+be added
+</p>
+<p>
+It serializes the request object into an input file and creates an empty
+output file. It then calls the external command reading the output file at
+the end.
+</p>
+<p>
+any STDERR gets logged at error level and any STDOUT gets logged at info
+level.
+</p>
+<p>
+It will interpret the exit code from the application the same way <a
+href="Reply.html#M000386">RPC::Reply#fail!</a> and fail handles their codes
+creating a consistent interface, the message part of the fail message will
+come from STDERR
+</p>
+<p>
+Generally externals should just exit with code 1 on failure and print to
+STDERR, this is exactly what Perl die() does and translates perfectly to
+our model
+</p>
+<p>
+It uses the <a href="../Shell.html">MCollective::Shell</a> wrapper to call
+the external application
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="command-attribute-method" class="method-detail">
+ <a name="command"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">command</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="agent-attribute-method" class="method-detail">
+ <a name="agent"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">agent</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="action-attribute-method" class="method-detail">
+ <a name="action"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">action</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="format-attribute-method" class="method-detail">
+ <a name="format"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">format</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="stdout-attribute-method" class="method-detail">
+ <a name="stdout"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">stdout</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="stderr-attribute-method" class="method-detail">
+ <a name="stderr"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">stderr</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="request-attribute-method" class="method-detail">
+ <a name="request"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">request</span><span
+ class="attribute-access-type">[R]</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="M000372"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(command, request, format=:json)</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/rpc/actionrunner.rb, line 26</span>
+26: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">request</span>, <span class="ruby-identifier">format</span>=<span class="ruby-identifier">:json</span>)
+27: <span class="ruby-ivar">@agent</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">agent</span>
+28: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">action</span>
+29: <span class="ruby-ivar">@format</span> = <span class="ruby-identifier">format</span>
+30: <span class="ruby-ivar">@request</span> = <span class="ruby-identifier">request</span>
+31: <span class="ruby-ivar">@command</span> = <span class="ruby-identifier">path_to_command</span>(<span class="ruby-identifier">command</span>)
+32: <span class="ruby-ivar">@stdout</span> = <span class="ruby-value str">""</span>
+33: <span class="ruby-ivar">@stderr</span> = <span class="ruby-value str">""</span>
+34: <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="canrun--method" class="method-detail ">
+ <a name="M000379"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">canrun?</span><span
+ class="method-args">(command)</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="canrun--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 117</span>
+117: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">canrun?</span>(<span class="ruby-identifier">command</span>)
+118: <span class="ruby-constant">File</span>.<span class="ruby-identifier">executable?</span>(<span class="ruby-identifier">command</span>)
+119: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="load-json-results-method" class="method-detail ">
+ <a name="M000376"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_json_results</span><span
+ class="method-args">(file)</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="load-json-results-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 91</span>
+91: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_json_results</span>(<span class="ruby-identifier">file</span>)
+92: <span class="ruby-keyword kw">return</span> {} <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">readable?</span>(<span class="ruby-identifier">file</span>)
+93:
+94: <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">file</span>)) <span class="ruby-operator">||</span> {}
+95: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">JSON</span><span class="ruby-operator">::</span><span class="ruby-constant">ParserError</span>
+96: {}
+97: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="load-results-method" class="method-detail ">
+ <a name="M000375"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_results</span><span
+ class="method-args">(file)</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="load-results-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 73</span>
+73: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_results</span>(<span class="ruby-identifier">file</span>)
+74: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Attempting to load results in #{format} format from #{file}"</span>)
+75:
+76: <span class="ruby-identifier">data</span> = {}
+77:
+78: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-node">"load_#{format}_results"</span>)
+79: <span class="ruby-identifier">tempdata</span> = <span class="ruby-identifier">send</span>(<span class="ruby-node">"load_#{format}_results"</span>, <span class="ruby-identifier">file</span>)
+80:
+81: <span class="ruby-identifier">tempdata</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
+82: <span class="ruby-identifier">data</span>[<span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">v</span>
+83: <span class="ruby-keyword kw">end</span>
+84: <span class="ruby-keyword kw">end</span>
+85:
+86: <span class="ruby-identifier">data</span>
+87: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+88: {}
+89: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="path-to-command-method" class="method-detail ">
+ <a name="M000382"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">path_to_command</span><span
+ class="method-args">(command)</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="path-to-command-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 129</span>
+129: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">path_to_command</span>(<span class="ruby-identifier">command</span>)
+130: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">command</span>[<span class="ruby-value">0</span>,<span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>
+131: <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">libdir</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">libdir</span><span class="ruby-operator">|</span>
+132: <span class="ruby-identifier">command_file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">libdir</span>, <span class="ruby-value str">"agent"</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">command</span>)
+133:
+134: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">command_file</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">command_file</span>)
+135: <span class="ruby-keyword kw">end</span>
+136: <span class="ruby-keyword kw">end</span>
+137:
+138: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">command</span>
+139: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="run-method" class="method-detail ">
+ <a name="M000373"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">run</span><span
+ class="method-args">()</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="run-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 36</span>
+36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>
+37: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">canrun?</span>(<span class="ruby-identifier">command</span>)
+38: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Cannot run #{to_s}"</span>)
+39: <span class="ruby-identifier">raise</span> <span class="ruby-constant">RPCAborted</span>, <span class="ruby-node">"Cannot execute #{to_s}"</span>
+40: <span class="ruby-keyword kw">end</span>
+41:
+42: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Running #{to_s}"</span>)
+43:
+44: <span class="ruby-identifier">request_file</span> = <span class="ruby-identifier">saverequest</span>(<span class="ruby-identifier">request</span>)
+45: <span class="ruby-identifier">reply_file</span> = <span class="ruby-identifier">tempfile</span>(<span class="ruby-value str">"reply"</span>)
+46: <span class="ruby-identifier">reply_file</span>.<span class="ruby-identifier">close</span>
+47:
+48: <span class="ruby-identifier">runner</span> = <span class="ruby-identifier">shell</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">request_file</span>.<span class="ruby-identifier">path</span>, <span class="ruby-identifier">reply_file</span>.<span class="ruby-identifier">path</span>)
+49:
+50: <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">runcommand</span>
+51:
+52: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"#{command} exited with #{runner.status.exitstatus}"</span>)
+53:
+54: <span class="ruby-identifier">stderr</span>.<span class="ruby-identifier">each_line</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"#{to_s}: #{l.chomp}"</span>)} <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">stderr</span>.<span class="ruby-identifier">empty?</span>
+55: <span class="ruby-identifier">stdout</span>.<span class="ruby-identifier">each_line</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">"#{to_s}: #{l.chomp}"</span>)} <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">stdout</span>.<span class="ruby-identifier">empty?</span>
+56:
+57: {<span class="ruby-identifier">:exitstatus</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">status</span>.<span class="ruby-identifier">exitstatus</span>,
+58: <span class="ruby-identifier">:stdout</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">stdout</span>,
+59: <span class="ruby-identifier">:stderr</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">stderr</span>,
+60: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">load_results</span>(<span class="ruby-identifier">reply_file</span>.<span class="ruby-identifier">path</span>)}
+61: <span class="ruby-keyword kw">ensure</span>
+62: <span class="ruby-identifier">request_file</span>.<span class="ruby-identifier">close!</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">request_file</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"close!"</span>)
+63: <span class="ruby-identifier">reply_file</span>.<span class="ruby-identifier">close!</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">reply_file</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"close"</span>)
+64: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="save-json-request-method" class="method-detail ">
+ <a name="M000378"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">save_json_request</span><span
+ class="method-args">(req)</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="save-json-request-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 113</span>
+113: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">save_json_request</span>(<span class="ruby-identifier">req</span>)
+114: <span class="ruby-identifier">req</span>.<span class="ruby-identifier">to_json</span>
+115: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="saverequest-method" class="method-detail ">
+ <a name="M000377"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">saverequest</span><span
+ class="method-args">(req)</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="saverequest-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 99</span>
+ 99: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">saverequest</span>(<span class="ruby-identifier">req</span>)
+100: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Attempting to save request in #{format} format"</span>)
+101:
+102: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-node">"save_#{format}_request"</span>)
+103: <span class="ruby-identifier">data</span> = <span class="ruby-identifier">send</span>(<span class="ruby-node">"save_#{format}_request"</span>, <span class="ruby-identifier">req</span>)
+104:
+105: <span class="ruby-identifier">request_file</span> = <span class="ruby-identifier">tempfile</span>(<span class="ruby-value str">"request"</span>)
+106: <span class="ruby-identifier">request_file</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">data</span>
+107: <span class="ruby-identifier">request_file</span>.<span class="ruby-identifier">close</span>
+108: <span class="ruby-keyword kw">end</span>
+109:
+110: <span class="ruby-identifier">request_file</span>
+111: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="shell-method" class="method-detail ">
+ <a name="M000374"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">shell</span><span
+ class="method-args">(command, infile, outfile)</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="shell-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 66</span>
+66: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">shell</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">infile</span>, <span class="ruby-identifier">outfile</span>)
+67: <span class="ruby-identifier">env</span> = {<span class="ruby-value str">"MCOLLECTIVE_REQUEST_FILE"</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">infile</span>,
+68: <span class="ruby-value str">"MCOLLECTIVE_REPLY_FILE"</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">outfile</span>}
+69:
+70: <span class="ruby-constant">Shell</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"#{command} #{infile} #{outfile}"</span>, <span class="ruby-identifier">:cwd</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">tmpdir</span>, <span class="ruby-identifier">:stdout</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">stdout</span>, <span class="ruby-identifier">:stderr</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">stderr</span>, <span class="ruby-identifier">:environment</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">env</span>)
+71: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="tempfile-method" class="method-detail ">
+ <a name="M000381"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">tempfile</span><span
+ class="method-args">(prefix)</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="tempfile-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 125</span>
+125: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tempfile</span>(<span class="ruby-identifier">prefix</span>)
+126: <span class="ruby-constant">Tempfile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"mcollective_#{prefix}"</span>, <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">tmpdir</span>)
+127: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="to-s-method" class="method-detail ">
+ <a name="M000380"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">to_s</span><span
+ class="method-args">()</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="to-s-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 121</span>
+121: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
+122: <span class="ruby-value str">"%s#%s command: %s"</span> <span class="ruby-operator">%</span> [ <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">command</span> ]
+123: <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>
+
--- /dev/null
+<?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::RPC::Agent</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/rpc/agent_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/agent.rb">lib/mcollective/rpc/agent.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="#M000411">::action</a></li>
+
+ <li><a href="#M000405">::actions</a></li>
+
+ <li><a href="#M000404">::activate?</a></li>
+
+ <li><a href="#M000410">::activate_when</a></li>
+
+ <li><a href="#M000412">::authorized_by</a></li>
+
+ <li><a href="#M000407">::metadata</a></li>
+
+ <li><a href="#M000393">::new</a></li>
+
+ <li><a href="#M000418">#after_processing_hook</a></li>
+
+ <li><a href="#M000419">#audit_request</a></li>
+
+ <li><a href="#M000417">#before_processing_hook</a></li>
+
+ <li><a href="#M000395">#handlemsg</a></li>
+
+ <li><a href="#M000415">#implemented_by</a></li>
+
+ <li><a href="#M000394">#load_ddl</a></li>
+
+ <li><a href="#M000406">#run</a></li>
+
+ <li><a href="#M000414">#shellescape</a></li>
+
+ <li><a href="#M000416">#startup_hook</a></li>
+
+ <li><a href="#M000413">#validate</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ <div id="includes-section" class="section">
+ <h3 class="section-header">Included Modules</h3>
+ <ul class="link-list">
+
+
+ <li><a class="include" href="../Validator.html">MCollective::Validator</a></li>
+
+
+ </ul>
+ </div>
+
+ </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::RPC::Agent</h1>
+
+ <div id="description">
+ <p>
+A wrapper around the traditional agent, it takes care of a lot of the
+tedious setup you would do for each agent allowing you to just create
+methods following a naming standard leaving the heavy lifting up to this
+clas.
+</p>
+<p>
+See <a
+href="http://marionette-collective.org/simplerpc/agents.html">marionette-collective.org/simplerpc/agents.html</a>
+</p>
+<p>
+It only really makes sense to use this with a Simple <a
+href="../RPC.html">RPC</a> client on the other end, basic usage would be:
+</p>
+<pre>
+ module MCollective
+ module Agent
+ class Helloworld<RPC::Agent
+ action "hello" do
+ reply[:msg] = "Hello #{request[:name]}"
+ end
+
+ action "foo" do
+ implemented_by "/some/script.sh"
+ end
+ end
+ end
+ end
+</pre>
+<p>
+If you wish to implement the logic for an action using an external script
+use the <a href="Agent.html#M000415">implemented_by</a> method that will
+cause your script to be run with 2 arguments.
+</p>
+<p>
+The first argument is a file containing JSON with the request and the 2nd
+argument is where the script should save its output as a JSON hash.
+</p>
+<p>
+We also currently have the validation code in here, this will be moved to
+plugins soon.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="reply-attribute-method" class="method-detail">
+ <a name="reply"></a>
+
+ <a name="reply="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">reply</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="request-attribute-method" class="method-detail">
+ <a name="request"></a>
+
+ <a name="request="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">request</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="agent-name-attribute-method" class="method-detail">
+ <a name="agent_name"></a>
+
+ <a name="agent_name="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">agent_name</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="logger-attribute-method" class="method-detail">
+ <a name="logger"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">logger</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="config-attribute-method" class="method-detail">
+ <a name="config"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">config</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="timeout-attribute-method" class="method-detail">
+ <a name="timeout"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">timeout</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ddl-attribute-method" class="method-detail">
+ <a name="ddl"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ddl</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="meta-attribute-method" class="method-detail">
+ <a name="meta"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">meta</span><span
+ class="attribute-access-type">[R]</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="actions-method" class="method-detail ">
+ <a name="M000405"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">actions</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns an array of actions this agent support
+</p>
+
+
+
+ <div class="method-source-code"
+ id="actions-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 157</span>
+157: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">actions</span>
+158: <span class="ruby-identifier">public_instance_methods</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-regexp re">/_action$/</span>).<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">method</span><span class="ruby-operator">|</span>
+159: <span class="ruby-identifier">$1</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">method</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/(.+)_action$/</span>
+160: <span class="ruby-keyword kw">end</span>
+161: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="activate--method" class="method-detail ">
+ <a name="M000404"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">activate?</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+By default <a href="../RPC.html">RPC</a> <a
+href="../Agents.html">Agents</a> support a toggle in the configuration that
+can enable and disable them based on the agent name
+</p>
+<p>
+Example an agent called Foo can have:
+</p>
+<p>
+plugin.foo.activate_agent = false
+</p>
+<p>
+and this will prevent the agent from loading on this particular machine.
+</p>
+<p>
+<a href="../Agents.html">Agents</a> can use the <a
+href="Agent.html#M000410">activate_when</a> helper to override this for
+example:
+</p>
+<p>
+<a href="Agent.html#M000410">activate_when</a> do
+</p>
+<pre>
+ File.exist?("/usr/bin/puppet")
+</pre>
+<p>
+end
+</p>
+
+
+
+ <div class="method-source-code"
+ id="activate--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 142</span>
+142: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">activate?</span>
+143: <span class="ruby-identifier">agent_name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"::"</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
+144:
+145: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC37</span>, <span class="ruby-value str">"Starting default activation checks for the '%{agent}' agent"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">agent_name</span>)
+146:
+147: <span class="ruby-identifier">should_activate</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">pluginconf</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-node">"#{agent_name}.activate_agent"</span>, <span class="ruby-keyword kw">true</span>))
+148:
+149: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">should_activate</span>
+150: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC38</span>, <span class="ruby-value str">"Found plugin configuration '%{agent}.activate_agent' with value '%{should_activate}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">agent_name</span>, <span class="ruby-identifier">:should_activate</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">should_activate</span>)
+151: <span class="ruby-keyword kw">end</span>
+152:
+153: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">should_activate</span>
+154: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="new-method" class="method-detail ">
+ <a name="M000393"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">()</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/rpc/agent.rb, line 40</span>
+40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+41: <span class="ruby-ivar">@agent_name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"::"</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
+42:
+43: <span class="ruby-identifier">load_ddl</span>
+44:
+45: <span class="ruby-ivar">@logger</span> = <span class="ruby-constant">Log</span>.<span class="ruby-identifier">instance</span>
+46: <span class="ruby-ivar">@config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
+47:
+48: <span class="ruby-comment cmt"># if we have a global authorization provider enable it</span>
+49: <span class="ruby-comment cmt"># plugins can still override it per plugin</span>
+50: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">authorized_by</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">rpcauthprovider</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">rpcauthorization</span>
+51:
+52: <span class="ruby-identifier">startup_hook</span>
+53: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+ <div id="private-class-method-details" class="method-section section">
+ <h3 class="section-header">Private Class Methods</h3>
+
+
+ <div id="action-method" class="method-detail ">
+ <a name="M000411"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">action</span><span
+ class="method-args">(name, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates a new action with the block passed and sets some defaults
+</p>
+<p>
+action “status” do
+</p>
+<pre>
+ # logic here to restart service
+</pre>
+<p>
+end
+</p>
+
+
+
+ <div class="method-source-code"
+ id="action-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 260</span>
+260: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">action</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+261: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Need to pass a body for the action"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">block_given?</span>
+262:
+263: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">module_eval</span> { <span class="ruby-identifier">define_method</span>(<span class="ruby-node">"#{name}_action"</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) }
+264: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="activate-when-method" class="method-detail ">
+ <a name="M000410"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">activate_when</span><span
+ class="method-args">(&block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates the needed activate? class in a manner similar to the other helpers
+like action, <a href="Agent.html#M000412">authorized_by</a> etc
+</p>
+<p>
+<a href="Agent.html#M000410">activate_when</a> do
+</p>
+<pre>
+ File.exist?("/usr/bin/puppet")
+</pre>
+<p>
+end
+</p>
+
+
+
+ <div class="method-source-code"
+ id="activate-when-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 249</span>
+249: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">activate_when</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+250: (<span class="ruby-keyword kw">class</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">self</span>; <span class="ruby-keyword kw">self</span>; <span class="ruby-keyword kw">end</span>).<span class="ruby-identifier">instance_eval</span> <span class="ruby-keyword kw">do</span>
+251: <span class="ruby-identifier">define_method</span>(<span class="ruby-value str">"activate?"</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+252: <span class="ruby-keyword kw">end</span>
+253: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="authorized-by-method" class="method-detail ">
+ <a name="M000412"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">authorized_by</span><span
+ class="method-args">(plugin)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Helper that creates a method on the class that will call your authorization
+plugin. If your plugin raises an exception that will abort the request
+</p>
+
+
+
+ <div class="method-source-code"
+ id="authorized-by-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 268</span>
+268: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">authorized_by</span>(<span class="ruby-identifier">plugin</span>)
+269: <span class="ruby-identifier">plugin</span> = <span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">capitalize</span>
+270:
+271: <span class="ruby-comment cmt"># turns foo_bar into FooBar</span>
+272: <span class="ruby-identifier">plugin</span> = <span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"_"</span>).<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">capitalize</span>}.<span class="ruby-identifier">join</span>
+273: <span class="ruby-identifier">pluginname</span> = <span class="ruby-node">"MCollective::Util::#{plugin}"</span>
+274:
+275: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-identifier">pluginname</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">constants</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">plugin</span>)
+276:
+277: <span class="ruby-identifier">class_eval</span>(<span class="ruby-node">"
+278: def authorization_hook(request)
+279: #{pluginname}.authorize(request)
+280: end
+281: "</span>)
+282: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="metadata-method" class="method-detail ">
+ <a name="M000407"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">metadata</span><span
+ class="method-args">(data)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Registers meta data for the introspection hash
+</p>
+
+
+
+ <div class="method-source-code"
+ id="metadata-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 237</span>
+237: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">metadata</span>(<span class="ruby-identifier">data</span>)
+238: <span class="ruby-identifier">agent</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">caller</span>.<span class="ruby-identifier">first</span>).<span class="ruby-identifier">split</span>(<span class="ruby-value str">":"</span>).<span class="ruby-identifier">first</span>
+239:
+240: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC34</span>, <span class="ruby-value str">"setting meta data in agents have been deprecated, DDL files are now being used for this information. Please update the '%{agent}' agent"</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">agent</span>)
+241: <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="handlemsg-method" class="method-detail ">
+ <a name="M000395"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">handlemsg</span><span
+ class="method-args">(msg, connection)</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="handlemsg-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 64</span>
+ 64: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">handlemsg</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">connection</span>)
+ 65: <span class="ruby-ivar">@request</span> = <span class="ruby-constant">RPC</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-ivar">@ddl</span>)
+ 66: <span class="ruby-ivar">@reply</span> = <span class="ruby-constant">RPC</span><span class="ruby-operator">::</span><span class="ruby-constant">Reply</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@request</span>.<span class="ruby-identifier">action</span>, <span class="ruby-ivar">@ddl</span>)
+ 67:
+ 68: <span class="ruby-keyword kw">begin</span>
+ 69: <span class="ruby-comment cmt"># Incoming requests need to be validated against the DDL thus reusing</span>
+ 70: <span class="ruby-comment cmt"># all the work users put into creating DDLs and creating a consistent</span>
+ 71: <span class="ruby-comment cmt"># quality of input validation everywhere with the a simple once off</span>
+ 72: <span class="ruby-comment cmt"># investment of writing a DDL</span>
+ 73: <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">validate!</span>
+ 74:
+ 75: <span class="ruby-comment cmt"># Calls the authorization plugin if any is defined</span>
+ 76: <span class="ruby-comment cmt"># if this raises an exception we wil just skip processing this</span>
+ 77: <span class="ruby-comment cmt"># message</span>
+ 78: <span class="ruby-identifier">authorization_hook</span>(<span class="ruby-ivar">@request</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"authorization_hook"</span>)
+ 79:
+ 80: <span class="ruby-comment cmt"># Audits the request, currently continues processing the message</span>
+ 81: <span class="ruby-comment cmt"># we should make this a configurable so that an audit failure means</span>
+ 82: <span class="ruby-comment cmt"># a message wont be processed by this node depending on config</span>
+ 83: <span class="ruby-identifier">audit_request</span>(<span class="ruby-ivar">@request</span>, <span class="ruby-identifier">connection</span>)
+ 84:
+ 85: <span class="ruby-identifier">before_processing_hook</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">connection</span>)
+ 86:
+ 87: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-node">"#{@request.action}_action"</span>)
+ 88: <span class="ruby-identifier">send</span>(<span class="ruby-node">"#{@request.action}_action"</span>)
+ 89: <span class="ruby-keyword kw">else</span>
+ 90: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC36</span>, <span class="ruby-value str">"Unknown action '%{action}' for agent '%{agent}'"</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">action</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">agent</span>)
+ 91: <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownRPCAction</span>, <span class="ruby-node">"Unknown action '#{@request.action}' for agent '#{@request.agent}'"</span>
+ 92: <span class="ruby-keyword kw">end</span>
+ 93: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">RPCAborted</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+ 94: <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">1</span>
+ 95:
+ 96: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">UnknownRPCAction</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+ 97: <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">2</span>
+ 98:
+ 99: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">MissingRPCData</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+100: <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">3</span>
+101:
+102: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">InvalidRPCData</span>, <span class="ruby-constant">DDLValidationError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+103: <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">4</span>
+104:
+105: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">UnknownRPCError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+106: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-value str">"%s#%s failed: %s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@agent_name</span>, <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">action</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>])
+107: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n\t"</span>))
+108: <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">5</span>
+109:
+110: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+111: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-value str">"%s#%s failed: %s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@agent_name</span>, <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">action</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>])
+112: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n\t"</span>))
+113: <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">5</span>
+114:
+115: <span class="ruby-keyword kw">end</span>
+116:
+117: <span class="ruby-identifier">after_processing_hook</span>
+118:
+119: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">should_respond?</span>
+120: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">to_hash</span>
+121: <span class="ruby-keyword kw">else</span>
+122: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC35</span>, <span class="ruby-value str">"Client did not request a response, surpressing reply"</span>, <span class="ruby-identifier">:debug</span>)
+123: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
+124: <span class="ruby-keyword kw">end</span>
+125: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="load-ddl-method" class="method-detail ">
+ <a name="M000394"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_ddl</span><span
+ class="method-args">()</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="load-ddl-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 55</span>
+55: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_ddl</span>
+56: <span class="ruby-ivar">@ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@agent_name</span>, <span class="ruby-identifier">:agent</span>)
+57: <span class="ruby-ivar">@meta</span> = <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">meta</span>
+58: <span class="ruby-ivar">@timeout</span> = <span class="ruby-ivar">@meta</span>[<span class="ruby-identifier">:timeout</span>] <span class="ruby-operator">||</span> <span class="ruby-value">10</span>
+59:
+60: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+61: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC24</span>, <span class="ruby-value str">"Failed to load DDL for the '%{agent}' agent, DDLs are required: %{error_class}: %{error}"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@agent_name</span>, <span class="ruby-identifier">:error_class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>)
+62: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+ <div id="private-instance-method-details" class="method-section section">
+ <h3 class="section-header">Private Instance Methods</h3>
+
+
+ <div id="after-processing-hook-method" class="method-detail ">
+ <a name="M000418"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">after_processing_hook</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Called at the end of processing just before the response gets sent to the
+middleware.
+</p>
+<p>
+This gets run outside of the main exception handling block of the agent so
+you should handle any exceptions you could raise yourself. The reason it is
+outside of the block is so you’ll have access to even status codes
+set by the exception handlers. If you do raise an exception it will just be
+passed onto the runner and processing will fail.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="after-processing-hook-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 356</span>
+356: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">after_processing_hook</span>
+357: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="audit-request-method" class="method-detail ">
+ <a name="M000419"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">audit_request</span><span
+ class="method-args">(msg, connection)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Gets called right after a request was received and calls audit plugins
+</p>
+<p>
+<a href="../Agents.html">Agents</a> can disable auditing by just overriding
+this method with a noop one this might be useful for agents that gets a lot
+of requests or simply if you do not care for the auditing in a specific
+agent.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="audit-request-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 364</span>
+364: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">audit_request</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">connection</span>)
+365: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"rpcaudit_plugin"</span>].<span class="ruby-identifier">audit_request</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">connection</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">rpcaudit</span>
+366: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+367: <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">:PLMC39</span>, <span class="ruby-value str">"Audit failed with an error, processing the request will continue."</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">e</span>)
+368: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="before-processing-hook-method" class="method-detail ">
+ <a name="M000417"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">before_processing_hook</span><span
+ class="method-args">(msg, connection)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Called just after a message was received from the middleware before it gets
+passed to the handlers. @request and @reply will already be set, the msg
+passed is the message as received from the normal mcollective runner and
+the connection is the actual connector.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="before-processing-hook-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 345</span>
+345: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">before_processing_hook</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">connection</span>)
+346: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="implemented-by-method" class="method-detail ">
+ <a name="M000415"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">implemented_by</span><span
+ class="method-args">(command, type=:json)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+handles external actions
+</p>
+
+
+
+ <div class="method-source-code"
+ id="implemented-by-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 313</span>
+313: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">implemented_by</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">type</span>=<span class="ruby-identifier">:json</span>)
+314: <span class="ruby-identifier">runner</span> = <span class="ruby-constant">ActionRunner</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">request</span>, <span class="ruby-identifier">type</span>)
+315:
+316: <span class="ruby-identifier">res</span> = <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">run</span>
+317:
+318: <span class="ruby-identifier">reply</span>.<span class="ruby-identifier">fail!</span> <span class="ruby-node">"Did not receive data from #{command}"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:data</span>)
+319: <span class="ruby-identifier">reply</span>.<span class="ruby-identifier">fail!</span> <span class="ruby-node">"Reply data from #{command} is not a Hash"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">res</span>[<span class="ruby-identifier">:data</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
+320:
+321: <span class="ruby-identifier">reply</span>.<span class="ruby-identifier">data</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">res</span>[<span class="ruby-identifier">:data</span>])
+322:
+323: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">res</span>[<span class="ruby-identifier">:exitstatus</span>] <span class="ruby-operator">></span> <span class="ruby-value">0</span>
+324: <span class="ruby-identifier">reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-node">"Failed to run #{command}: #{res[:stderr]}"</span>, <span class="ruby-identifier">res</span>[<span class="ruby-identifier">:exitstatus</span>]
+325: <span class="ruby-keyword kw">end</span>
+326: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+327: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Unhandled #{e.class} exception during #{request.agent}##{request.action}: #{e}"</span>)
+328: <span class="ruby-identifier">reply</span>.<span class="ruby-identifier">fail!</span> <span class="ruby-node">"Unexpected failure calling #{command}: #{e.class}: #{e}"</span>
+329: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="run-method" class="method-detail ">
+ <a name="M000406"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">run</span><span
+ class="method-args">(command, options={})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Runs a command via the MC::Shell wrapper, options are as per MC::Shell
+</p>
+<p>
+The simplest use is:
+</p>
+<pre>
+ out = ""
+ err = ""
+ status = run("echo 1", :stdout => out, :stderr => err)
+
+ reply[:out] = out
+ reply[:error] = err
+ reply[:exitstatus] = status
+</pre>
+<p>
+This can be simplified as:
+</p>
+<pre>
+ reply[:exitstatus] = run("echo 1", :stdout => :out, :stderr => :error)
+</pre>
+<p>
+You can set a command specific environment and cwd:
+</p>
+<pre>
+ run("echo 1", :cwd => "/tmp", :environment => {"FOO" => "BAR"})
+</pre>
+<p>
+This will run ‘echo 1’ from /tmp with FOO=BAR in addition to a
+setting forcing LC_ALL = C. To prevent LC_ALL from being set either set it
+specifically or:
+</p>
+<pre>
+ run("echo 1", :cwd => "/tmp", :environment => nil)
+</pre>
+<p>
+Exceptions here will be handled by the usual agent exception handler or any
+specific one you create, if you dont it will just fall through and be sent
+to the client.
+</p>
+<p>
+If the shell handler fails to return a Process::Status instance for exit
+status this method will return -1 as the exit status
+</p>
+
+
+
+ <div class="method-source-code"
+ id="run-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 195</span>
+195: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">options</span>={})
+196: <span class="ruby-identifier">shellopts</span> = {}
+197:
+198: <span class="ruby-comment cmt"># force stderr and stdout to be strings as the library</span>
+199: <span class="ruby-comment cmt"># will append data to them if given using the << method.</span>
+200: <span class="ruby-comment cmt">#</span>
+201: <span class="ruby-comment cmt"># if the data pased to :stderr or :stdin is a Symbol</span>
+202: <span class="ruby-comment cmt"># add that into the reply hash with that Symbol</span>
+203: [<span class="ruby-identifier">:stderr</span>, <span class="ruby-identifier">:stdout</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span>
+204: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">k</span>)
+205: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">k</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Symbol</span>)
+206: <span class="ruby-identifier">reply</span>[ <span class="ruby-identifier">options</span>[<span class="ruby-identifier">k</span>] ] = <span class="ruby-value str">""</span>
+207: <span class="ruby-identifier">shellopts</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">reply</span>[ <span class="ruby-identifier">options</span>[<span class="ruby-identifier">k</span>] ]
+208: <span class="ruby-keyword kw">else</span>
+209: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">k</span>].<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"<<"</span>)
+210: <span class="ruby-identifier">shellopts</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">k</span>]
+211: <span class="ruby-keyword kw">else</span>
+212: <span class="ruby-identifier">reply</span>.<span class="ruby-identifier">fail!</span> <span class="ruby-node">"#{k} should support << while calling run(#{command})"</span>
+213: <span class="ruby-keyword kw">end</span>
+214: <span class="ruby-keyword kw">end</span>
+215: <span class="ruby-keyword kw">end</span>
+216: <span class="ruby-keyword kw">end</span>
+217:
+218: [<span class="ruby-identifier">:stdin</span>, <span class="ruby-identifier">:cwd</span>, <span class="ruby-identifier">:environment</span>, <span class="ruby-identifier">:timeout</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span>
+219: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">k</span>)
+220: <span class="ruby-identifier">shellopts</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">k</span>]
+221: <span class="ruby-keyword kw">end</span>
+222: <span class="ruby-keyword kw">end</span>
+223:
+224: <span class="ruby-identifier">shell</span> = <span class="ruby-constant">Shell</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">shellopts</span>)
+225:
+226: <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">runcommand</span>
+227:
+228: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:chomp</span>]
+229: <span class="ruby-identifier">shellopts</span>[<span class="ruby-identifier">:stdout</span>].<span class="ruby-identifier">chomp!</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">shellopts</span>[<span class="ruby-identifier">:stdout</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
+230: <span class="ruby-identifier">shellopts</span>[<span class="ruby-identifier">:stderr</span>].<span class="ruby-identifier">chomp!</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">shellopts</span>[<span class="ruby-identifier">:stderr</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
+231: <span class="ruby-keyword kw">end</span>
+232:
+233: <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">status</span>.<span class="ruby-identifier">exitstatus</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-value">-1</span>
+234: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="shellescape-method" class="method-detail ">
+ <a name="M000414"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">shellescape</span><span
+ class="method-args">(str)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+convenience wrapper around <a
+href="../Util.html#M000311">Util#shellescape</a>
+</p>
+
+
+
+ <div class="method-source-code"
+ id="shellescape-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 308</span>
+308: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">shellescape</span>(<span class="ruby-identifier">str</span>)
+309: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">shellescape</span>(<span class="ruby-identifier">str</span>)
+310: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="startup-hook-method" class="method-detail ">
+ <a name="M000416"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">startup_hook</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Called at the end of the <a href="Agent.html">RPC::Agent</a> standard
+initialize method use this to adjust meta parameters, timeouts and any
+setup you need to do.
+</p>
+<p>
+This will not be called right when the daemon starts up, we use lazy
+loading and initialization so it will only be called the first time a
+request for this agent arrives.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="startup-hook-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 338</span>
+338: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">startup_hook</span>
+339: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-method" class="method-detail ">
+ <a name="M000413"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate</span><span
+ class="method-args">(key, validation)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Validates a data member, if validation is a regex then it will try to match
+it else it supports testing object types only:
+</p>
+<p>
+validate :msg, <a href="../../String.html">String</a> validate :msg,
+/^[w\s]+$/
+</p>
+<p>
+There are also some special helper validators:
+</p>
+<p>
+validate :command, :shellsafe validate :command, :ipv6address validate
+:command, :ipv4address validate :command, :boolean validate :command,
+[“start”, “stop”]
+</p>
+<p>
+It will raise appropriate exceptions that the <a href="../RPC.html">RPC</a>
+system understand
+</p>
+
+
+
+ <div class="method-source-code"
+ id="validate-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 299</span>
+299: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">validation</span>)
+300: <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingRPCData</span>, <span class="ruby-node">"please supply a #{key} argument"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
+301:
+302: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">validate</span>(<span class="ruby-ivar">@request</span>[<span class="ruby-identifier">key</span>], <span class="ruby-identifier">validation</span>)
+303: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">ValidatorError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+304: <span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidRPCData</span>, <span class="ruby-value str">"Input %s did not pass validation: %s"</span> <span class="ruby-operator">%</span> [ <span class="ruby-identifier">key</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span> ]
+305: <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>
+
--- /dev/null
+<?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::RPC::Audit</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/rpc/audit_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/audit.rb">lib/mcollective/rpc/audit.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="#M000408">::inherited</a></li>
+
+ <li><a href="#M000409">#audit_request</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::RPC::Audit</h1>
+
+ <div id="description">
+ <p>
+Auditing of requests is done only for SimpleRPC requests, you provide a
+plugin in the MCollective::Audit::* namespace which the SimpleRPC framework
+calls for each message
+</p>
+<p>
+We provide a simple one that logs to a logfile in the class
+MCollective::Audit::Logfile you can create your own:
+</p>
+<p>
+Create a class in plugins/mcollective/audit/<yourplugin>.rb
+</p>
+<p>
+You must inherit from <a href="Audit.html">MCollective::RPC::Audit</a>
+which will take care of registering you with the plugin system.
+</p>
+<p>
+Your plugin must provide <a
+href="Audit.html#M000409">audit_request</a>(request, connection) the
+request parameter will be an instance of <a
+href="Request.html">MCollective::RPC::Request</a>
+</p>
+<p>
+To enable auditing you should set:
+</p>
+<p>
+rpcaudit = 1 rpcauditprovider = Logfile
+</p>
+<p>
+in the config file this will enable logging using the
+MCollective::Audit::Logile class
+</p>
+<p>
+The <a href="Audit.html">Audit</a> class acts as a base for audit plugins
+and takes care of registering them with the plugin manager
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="inherited-method" class="method-detail ">
+ <a name="M000408"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">inherited</span><span
+ class="method-args">(klass)</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="inherited-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/audit.rb, line 29</span>
+29: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
+30: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"rpcaudit_plugin"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>}
+31: <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="audit-request-method" class="method-detail ">
+ <a name="M000409"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">audit_request</span><span
+ class="method-args">(request, connection)</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="audit-request-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/audit.rb, line 33</span>
+33: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">audit_request</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">connection</span>)
+34: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"audit_request is not implimented in #{this.class}"</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>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>Class: MCollective::RPC::Client</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::Client</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/client_rb.html">
- lib/mcollective/rpc/client.rb
- </a>
- <br />
- </td>
- </tr>
+ <title>Class: MCollective::RPC::Client</title>
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
+ <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
- <div id="bodyContent">
+ <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>
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
+</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/rpc/client_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/client.rb">lib/mcollective/rpc/client.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="#M000443">::new</a></li>
+
+ <li><a href="#M000461">#agent_filter</a></li>
+
+ <li><a href="#M000475">#aggregate_reply</a></li>
+
+ <li><a href="#M000471">#batch_size=</a></li>
+
+ <li><a href="#M000472">#batch_sleep_time=</a></li>
+
+ <li><a href="#M000480">#call_agent</a></li>
+
+ <li><a href="#M000479">#call_agent_batched</a></li>
+
+ <li><a href="#M000459">#class_filter</a></li>
+
+ <li><a href="#M000468">#collective=</a></li>
+
+ <li><a href="#M000463">#compound_filter</a></li>
+
+ <li><a href="#M000454">#custom_request</a></li>
+
+ <li><a href="#M000446">#disconnect</a></li>
+
+ <li><a href="#M000466">#discover</a></li>
+
+ <li><a href="#M000457">#discovery_method=</a></li>
+
+ <li><a href="#M000458">#discovery_options=</a></li>
+
+ <li><a href="#M000455">#discovery_timeout</a></li>
+
+ <li><a href="#M000456">#discovery_timeout=</a></li>
+
+ <li><a href="#M000460">#fact_filter</a></li>
+
+ <li><a href="#M000477">#fire_and_forget_request</a></li>
+
+ <li><a href="#M000447">#help</a></li>
+
+ <li><a href="#M000462">#identity_filter</a></li>
+
+ <li><a href="#M000478">#identity_filter_discovery_optimization</a></li>
+
+ <li><a href="#M000470">#limit_method=</a></li>
+
+ <li><a href="#M000469">#limit_targets=</a></li>
+
+ <li><a href="#M000474">#load_aggregate_functions</a></li>
+
+ <li><a href="#M000452">#method_missing</a></li>
+
+ <li><a href="#M000448">#new_request</a></li>
+
+ <li><a href="#M000467">#options</a></li>
+
+ <li><a href="#M000473">#pick_nodes_from_discovered</a></li>
+
+ <li><a href="#M000485">#process_results_with_block</a></li>
+
+ <li><a href="#M000481">#process_results_without_block</a></li>
+
+ <li><a href="#M000464">#reset</a></li>
+
+ <li><a href="#M000465">#reset_filter</a></li>
+
+ <li><a href="#M000476">#rpc_result_from_reply</a></li>
+
+ <li><a href="#M000449">#validate_request</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::RPC::Client</h1>
+
+ <div id="description">
+ <p>
The main component of the Simple <a href="../RPC.html">RPC</a> client
system, this wraps around <a href="../Client.html">MCollective::Client</a>
and just brings in a lot of convention and standard approached.
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000098">agent_filter</a>
- <a href="#M000112">aggregate_reply</a>
- <a href="#M000108">batch_size=</a>
- <a href="#M000109">batch_sleep_time=</a>
- <a href="#M000117">call_agent</a>
- <a href="#M000116">call_agent_batched</a>
- <a href="#M000096">class_filter</a>
- <a href="#M000105">collective=</a>
- <a href="#M000100">compound_filter</a>
- <a href="#M000091">custom_request</a>
- <a href="#M000086">disconnect</a>
- <a href="#M000103">discover</a>
- <a href="#M000094">discovery_method=</a>
- <a href="#M000095">discovery_options=</a>
- <a href="#M000092">discovery_timeout</a>
- <a href="#M000093">discovery_timeout=</a>
- <a href="#M000097">fact_filter</a>
- <a href="#M000114">fire_and_forget_request</a>
- <a href="#M000087">help</a>
- <a href="#M000099">identity_filter</a>
- <a href="#M000115">identity_filter_discovery_optimization</a>
- <a href="#M000107">limit_method=</a>
- <a href="#M000106">limit_targets=</a>
- <a href="#M000111">load_aggregate_functions</a>
- <a href="#M000090">method_missing</a>
- <a href="#M000085">new</a>
- <a href="#M000088">new_request</a>
- <a href="#M000104">options</a>
- <a href="#M000110">pick_nodes_from_discovered</a>
- <a href="#M000119">process_results_with_block</a>
- <a href="#M000118">process_results_without_block</a>
- <a href="#M000101">reset</a>
- <a href="#M000102">reset_filter</a>
- <a href="#M000113">rpc_result_from_reply</a>
- <a href="#M000089">validate_request</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">agent</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">batch_mode</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">batch_size</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">batch_sleep_time</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">client</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">config</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ddl</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">default_discovery_method</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">discovery_method</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">discovery_options</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">filter</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">limit_method</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">limit_seed</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">limit_targets</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">output_format</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">progress</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">reply_to</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">stats</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">timeout</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ttl</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">verbose</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000085" class="method-detail">
- <a name="M000085"></a>
-
- <div class="method-heading">
- <a href="#M000085" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(agent, flags = {}) {|parser, opts| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates a stub for a remote agent, you can pass in an <a
-href="Client.html#M000104">options</a> array in the flags which will then
-be used else it will just create a default <a
-href="Client.html#M000104">options</a> array with filtering enabled based
-on the standard command line use.
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="timeout-attribute-method" class="method-detail">
+ <a name="timeout"></a>
+
+ <a name="timeout="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">timeout</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="verbose-attribute-method" class="method-detail">
+ <a name="verbose"></a>
+
+ <a name="verbose="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">verbose</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="filter-attribute-method" class="method-detail">
+ <a name="filter"></a>
+
+ <a name="filter="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">filter</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="config-attribute-method" class="method-detail">
+ <a name="config"></a>
+
+ <a name="config="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">config</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="progress-attribute-method" class="method-detail">
+ <a name="progress"></a>
+
+ <a name="progress="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">progress</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ttl-attribute-method" class="method-detail">
+ <a name="ttl"></a>
+
+ <a name="ttl="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ttl</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="reply-to-attribute-method" class="method-detail">
+ <a name="reply_to"></a>
+
+ <a name="reply_to="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">reply_to</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="client-attribute-method" class="method-detail">
+ <a name="client"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">client</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="stats-attribute-method" class="method-detail">
+ <a name="stats"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">stats</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ddl-attribute-method" class="method-detail">
+ <a name="ddl"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ddl</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="agent-attribute-method" class="method-detail">
+ <a name="agent"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">agent</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="limit-targets-attribute-method" class="method-detail">
+ <a name="limit_targets"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">limit_targets</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="limit-method-attribute-method" class="method-detail">
+ <a name="limit_method"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">limit_method</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="output-format-attribute-method" class="method-detail">
+ <a name="output_format"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">output_format</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="batch-size-attribute-method" class="method-detail">
+ <a name="batch_size"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">batch_size</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="batch-sleep-time-attribute-method" class="method-detail">
+ <a name="batch_sleep_time"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">batch_sleep_time</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="batch-mode-attribute-method" class="method-detail">
+ <a name="batch_mode"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">batch_mode</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="discovery-options-attribute-method" class="method-detail">
+ <a name="discovery_options"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">discovery_options</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="discovery-method-attribute-method" class="method-detail">
+ <a name="discovery_method"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">discovery_method</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="default-discovery-method-attribute-method" class="method-detail">
+ <a name="default_discovery_method"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">default_discovery_method</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="limit-seed-attribute-method" class="method-detail">
+ <a name="limit_seed"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">limit_seed</span><span
+ class="attribute-access-type">[R]</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="M000443"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(agent, flags = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates a stub for a remote agent, you can pass in an options array in the
+flags which will then be used else it will just create a default options
+array with filtering enabled based on the standard command line use.
</p>
<pre>
rpc = RPC::Client.new("rpctest", :configfile => "client.cfg", :options => options)
</pre>
<p>
-You typically would not call this directly you̵
6;d use <a
-href="../RPC.html#M000037">MCollective::RPC#rpcclient</a> instead which is
+You typically would not call this directly you̵
7;d use <a
+href="../RPC.html#M000314">MCollective::RPC#rpcclient</a> instead which is
a wrapper around this that can be used as a Mixin
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000085-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000085-source">
+
+
+
+ <div class="method-source-code"
+ id="new-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 20</span>
20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">flags</span> = {})
115: <span class="ruby-ivar">@stdout</span> = <span class="ruby-constant">STDOUT</span>
116: <span class="ruby-ivar">@stdout</span>.<span class="ruby-identifier">sync</span> = <span class="ruby-keyword kw">true</span>
117: <span class="ruby-keyword kw">end</span>
-118: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000098" class="method-detail">
- <a name="M000098"></a>
-
- <div class="method-heading">
- <a href="#M000098" class="method-signature">
- <span class="method-name">agent_filter</span><span class="method-args">(agent)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+118: <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-filter-method" class="method-detail ">
+ <a name="M000461"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">agent_filter</span><span
+ class="method-args">(agent)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the agent filter
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000098-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000098-source">
+
+
+
+ <div class="method-source-code"
+ id="agent-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 422</span>
422: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">agent_filter</span>(<span class="ruby-identifier">agent</span>)
423: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"agent"</span>] = <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"agent"</span>] <span class="ruby-operator">|</span> [<span class="ruby-identifier">agent</span>]
424: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"agent"</span>].<span class="ruby-identifier">compact!</span>
425: <span class="ruby-identifier">reset</span>
-426: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000112" class="method-detail">
- <a name="M000112"></a>
-
- <div class="method-heading">
- <a href="#M000112" class="method-signature">
- <span class="method-name">aggregate_reply</span><span class="method-args">(reply, aggregate)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000112-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000112-source">
+426: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="aggregate-reply-method" class="method-detail ">
+ <a name="M000475"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">aggregate_reply</span><span
+ class="method-args">(reply, aggregate)</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="aggregate-reply-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 687</span>
687: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">aggregate_reply</span>(<span class="ruby-identifier">reply</span>, <span class="ruby-identifier">aggregate</span>)
692: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
693: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-value str">"Failed to calculate aggregate summaries for reply from %s, calculating summaries disabled: %s: %s (%s)"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:senderid</span>], <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">first</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>])
694: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
-695: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000108" class="method-detail">
- <a name="M000108"></a>
-
- <div class="method-heading">
- <a href="#M000108" class="method-signature">
- <span class="method-name">batch_size=</span><span class="method-args">(limit)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+695: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="batch-size--method" class="method-detail ">
+ <a name="M000471"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">batch_size=</span><span
+ class="method-args">(limit)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the batch size, if the size is set to 0 that will disable batch mode
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000108-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000108-source">
+
+
+
+ <div class="method-source-code"
+ id="batch-size--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 608</span>
608: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">batch_size=</span>(<span class="ruby-identifier">limit</span>)
610:
611: <span class="ruby-ivar">@batch_size</span> = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">limit</span>)
612: <span class="ruby-ivar">@batch_mode</span> = <span class="ruby-ivar">@batch_size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
-613: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000109" class="method-detail">
- <a name="M000109"></a>
-
- <div class="method-heading">
- <a href="#M000109" class="method-signature">
- <span class="method-name">batch_sleep_time=</span><span class="method-args">(time)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000109-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000109-source">
+613: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="batch-sleep-time--method" class="method-detail ">
+ <a name="M000472"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">batch_sleep_time=</span><span
+ class="method-args">(time)</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="batch-sleep-time--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 615</span>
615: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">batch_sleep_time=</span>(<span class="ruby-identifier">time</span>)
616: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Can only set batch sleep time if direct addressing is supported"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">direct_addressing</span>
617:
618: <span class="ruby-ivar">@batch_sleep_time</span> = <span class="ruby-constant">Float</span>(<span class="ruby-identifier">time</span>)
-619: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000117" class="method-detail">
- <a name="M000117"></a>
-
- <div class="method-heading">
- <a href="#M000117" class="method-signature">
- <span class="method-name">call_agent</span><span class="method-args">(action, args, opts, disc=:auto, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+619: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="call-agent-method" class="method-detail ">
+ <a name="M000480"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">call_agent</span><span
+ class="method-args">(action, args, opts, disc=:auto, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Handles traditional calls to the remote agents with full stats blocks, non
blocks and everything else supported.
</p>
<p>
Other methods of calling the nodes can reuse this code by for example
-specifying custom <a href="Client.html#M000104">options</a> and discovery
-data
+specifying custom options and discovery data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000117-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000117-source">
+
+
+
+ <div class="method-source-code"
+ id="call-agent-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 844</span>
844: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call_agent</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">opts</span>, <span class="ruby-identifier">disc</span>=<span class="ruby-identifier">:auto</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
916: <span class="ruby-keyword kw">else</span>
917: <span class="ruby-keyword kw">return</span> [<span class="ruby-identifier">results</span>].<span class="ruby-identifier">flatten</span>
918: <span class="ruby-keyword kw">end</span>
-919: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000116" class="method-detail">
- <a name="M000116"></a>
-
- <div class="method-heading">
- <a href="#M000116" class="method-signature">
- <span class="method-name">call_agent_batched</span><span class="method-args">(action, args, opts, batch_size, sleep_time, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+919: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="call-agent-batched-method" class="method-detail ">
+ <a name="M000479"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">call_agent_batched</span><span
+ class="method-args">(action, args, opts, batch_size, sleep_time, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Calls an agent in a way very similar to <a
-href="Client.html#M000117">call_agent</a> but it supports batching the
+href="Client.html#M000480">call_agent</a> but it supports batching the
queries to the network.
</p>
<p>
The result sets, stats, block handling etc is all exactly like you would
-expect from normal <a href="Client.html#M000117">call_agent</a>.
+expect from normal call_agent.
</p>
<p>
-This is used by <a href="Client.html#M000090">method_missing</a> and works
+This is used by <a href="Client.html#M000452">method_missing</a> and works
only with direct addressing mode
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000116-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000116-source">
+
+
+
+ <div class="method-source-code"
+ id="call-agent-batched-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 759</span>
759: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call_agent_batched</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">opts</span>, <span class="ruby-identifier">batch_size</span>, <span class="ruby-identifier">sleep_time</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
834: <span class="ruby-keyword kw">else</span>
835: <span class="ruby-keyword kw">return</span> [<span class="ruby-identifier">results</span>].<span class="ruby-identifier">flatten</span>
836: <span class="ruby-keyword kw">end</span>
-837: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000096" class="method-detail">
- <a name="M000096"></a>
-
- <div class="method-heading">
- <a href="#M000096" class="method-signature">
- <span class="method-name">class_filter</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+837: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="class-filter-method" class="method-detail ">
+ <a name="M000459"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">class_filter</span><span
+ class="method-args">(klass)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the class filter
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000096-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000096-source">
+
+
+
+ <div class="method-source-code"
+ id="class-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 398</span>
398: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">class_filter</span>(<span class="ruby-identifier">klass</span>)
399: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"cf_class"</span>] = <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"cf_class"</span>] <span class="ruby-operator">|</span> [<span class="ruby-identifier">klass</span>]
400: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"cf_class"</span>].<span class="ruby-identifier">compact!</span>
401: <span class="ruby-identifier">reset</span>
-402: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000105" class="method-detail">
- <a name="M000105"></a>
-
- <div class="method-heading">
- <a href="#M000105" class="method-signature">
- <span class="method-name">collective=</span><span class="method-args">(c)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+402: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="collective--method" class="method-detail ">
+ <a name="M000468"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">collective=</span><span
+ class="method-args">(c)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the collective we are communicating with
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000105-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000105-source">
+
+
+
+ <div class="method-source-code"
+ id="collective--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 573</span>
573: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">collective=</span>(<span class="ruby-identifier">c</span>)
576: <span class="ruby-ivar">@collective</span> = <span class="ruby-identifier">c</span>
577: <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">options</span> = <span class="ruby-identifier">options</span>
578: <span class="ruby-identifier">reset</span>
-579: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000100" class="method-detail">
- <a name="M000100"></a>
-
- <div class="method-heading">
- <a href="#M000100" class="method-signature">
- <span class="method-name">compound_filter</span><span class="method-args">(filter)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+579: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="compound-filter-method" class="method-detail ">
+ <a name="M000463"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">compound_filter</span><span
+ class="method-args">(filter)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Set a compound filter
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000100-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000100-source">
+
+
+
+ <div class="method-source-code"
+ id="compound-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 436</span>
436: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">compound_filter</span>(<span class="ruby-identifier">filter</span>)
437: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"compound"</span>] = <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"compound"</span>] <span class="ruby-operator">|</span> [<span class="ruby-constant">Matcher</span>.<span class="ruby-identifier">create_compound_callstack</span>(<span class="ruby-identifier">filter</span>)]
438: <span class="ruby-identifier">reset</span>
-439: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000091" class="method-detail">
- <a name="M000091"></a>
-
- <div class="method-heading">
- <a href="#M000091" class="method-signature">
- <span class="method-name">custom_request</span><span class="method-args">(action, args, expected_agents, filter = {}, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+439: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="custom-request-method" class="method-detail ">
+ <a name="M000454"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">custom_request</span><span
+ class="method-args">(action, args, expected_agents, filter = {}, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Constructs custom requests with custom filters and discovery data the idea
is that this would be used in web applications where you might be using a
cached copy of data provided by a registration agent to figure out on your
own what nodes will be responding and what your filter would be.
</p>
<p>
-This will <a href="Client.html#M000087">help</a> you essentially short
-circuit the traditional cycle of:
+This will help you essentially short circuit the traditional cycle of:
</p>
<p>
-mc <a href="Client.html#M000103">discover</a> / call / wait for discovered
-nodes
+mc discover / call / wait for discovered nodes
</p>
<p>
by doing discovery however you like, contructing a filter and a list of
</p>
<p>
If you just wanted to contact one machine for example with a client that
-already has other filter <a href="Client.html#M000104">options</a> setup
-you can do:
+already has other filter options setup you can do:
</p>
<p>
-puppet.custom_request("runonce", {}, ["your.box.com"],
-{:identity => "your.box.com"})
+puppet.custom_request(“runonce”, {},
+[“your.box.com“], {:identity => “your.box.com“})
</p>
<p>
This will do runonce action on just ‘your.box.com’, no
request which technically does not need filters. If you try to use this
mode with direct addressing disabled an exception will be raise
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000091-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000091-source">
+
+
+
+ <div class="method-source-code"
+ id="custom-request-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 296</span>
296: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">custom_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">expected_agents</span>, <span class="ruby-identifier">filter</span> = {}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
339: <span class="ruby-keyword kw">else</span>
340: <span class="ruby-identifier">call_agent</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">custom_options</span>, [<span class="ruby-identifier">expected_agents</span>].<span class="ruby-identifier">flatten</span>)
341: <span class="ruby-keyword kw">end</span>
-342: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000086" class="method-detail">
- <a name="M000086"></a>
-
- <div class="method-heading">
- <a href="#M000086" class="method-signature">
- <span class="method-name">disconnect</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+342: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="disconnect-method" class="method-detail ">
+ <a name="M000446"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">disconnect</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Disconnects cleanly from the middleware
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000086-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000086-source">
+
+
+
+ <div class="method-source-code"
+ id="disconnect-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 121</span>
121: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">disconnect</span>
122: <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">disconnect</span>
-123: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000103" class="method-detail">
- <a name="M000103"></a>
-
- <div class="method-heading">
- <a href="#M000103" class="method-signature">
- <span class="method-name">discover</span><span class="method-args">(flags={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+123: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discover-method" class="method-detail ">
+ <a name="M000466"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discover</span><span
+ class="method-args">(flags={})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Does discovery based on the filters set, if a discovery was previously done
-return that else do a <a href="Client.html#M000085">new</a> discovery.
+return that else do a new discovery.
</p>
<p>
Alternatively if identity filters are given and none of them are regular
the :verbose flag is passed in.
</p>
<p>
-Use <a href="Client.html#M000101">reset</a> to force a <a
-href="Client.html#M000085">new</a> discovery
+Use reset to force a new discovery
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000103-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000103-source">
+
+
+
+ <div class="method-source-code"
+ id="discover-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 468</span>
468: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discover</span>(<span class="ruby-identifier">flags</span>={})
549: <span class="ruby-constant">RPC</span>.<span class="ruby-identifier">discovered</span>(<span class="ruby-ivar">@discovered_agents</span>)
550:
551: <span class="ruby-ivar">@discovered_agents</span>
-552: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000094" class="method-detail">
- <a name="M000094"></a>
-
- <div class="method-heading">
- <a href="#M000094" class="method-signature">
- <span class="method-name">discovery_method=</span><span class="method-args">(method)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+552: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-method--method" class="method-detail ">
+ <a name="M000457"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery_method=</span><span
+ class="method-args">(method)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the discovery method. If we change the method there are a number of
steps to take:
</p>
</pre>
<p>
The remaining item is the discovery timeout, we leave that as is since that
-is the user supplied timeout either via initial <a
-href="Client.html#M000104">options</a> or via specifically setting it on
-the client.
+is the user supplied timeout either via initial options or via specifically
+setting it on the client.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000094-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000094-source">
+
+
+
+ <div class="method-source-code"
+ id="discovery-method--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 377</span>
377: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_method=</span>(<span class="ruby-identifier">method</span>)
387: <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">options</span> = <span class="ruby-identifier">options</span>
388:
389: <span class="ruby-identifier">reset</span>
-390: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000095" class="method-detail">
- <a name="M000095"></a>
-
- <div class="method-heading">
- <a href="#M000095" class="method-signature">
- <span class="method-name">discovery_options=</span><span class="method-args">(options)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000095-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000095-source">
+390: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-options--method" class="method-detail ">
+ <a name="M000458"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery_options=</span><span
+ class="method-args">(options)</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="discovery-options--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 392</span>
392: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_options=</span>(<span class="ruby-identifier">options</span>)
393: <span class="ruby-ivar">@discovery_options</span> = [<span class="ruby-identifier">options</span>].<span class="ruby-identifier">flatten</span>
394: <span class="ruby-identifier">reset</span>
-395: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000092" class="method-detail">
- <a name="M000092"></a>
-
- <div class="method-heading">
- <a href="#M000092" class="method-signature">
- <span class="method-name">discovery_timeout</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000092-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000092-source">
+395: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-timeout-method" class="method-detail ">
+ <a name="M000455"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery_timeout</span><span
+ class="method-args">()</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="discovery-timeout-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 344</span>
344: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_timeout</span>
345: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@discovery_timeout</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@discovery_timeout</span>
346: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">discoverer</span>.<span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:timeout</span>]
-347: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000093" class="method-detail">
- <a name="M000093"></a>
-
- <div class="method-heading">
- <a href="#M000093" class="method-signature">
- <span class="method-name">discovery_timeout=</span><span class="method-args">(timeout)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000093-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000093-source">
+347: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovery-timeout--method" class="method-detail ">
+ <a name="M000456"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovery_timeout=</span><span
+ class="method-args">(timeout)</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="discovery-timeout--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 349</span>
349: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_timeout=</span>(<span class="ruby-identifier">timeout</span>)
358: <span class="ruby-comment cmt"># calculate a correct timeout based on DDL timeout and the</span>
359: <span class="ruby-comment cmt"># supplied discovery timeout</span>
360: <span class="ruby-ivar">@timeout</span> = <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:timeout</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">discovery_timeout</span>
-361: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000097" class="method-detail">
- <a name="M000097"></a>
-
- <div class="method-heading">
- <a href="#M000097" class="method-signature">
- <span class="method-name">fact_filter</span><span class="method-args">(fact, value=nil, operator="=")</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+361: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="fact-filter-method" class="method-detail ">
+ <a name="M000460"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">fact_filter</span><span
+ class="method-args">(fact, value=nil, operator="=")</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the fact filter
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000097-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000097-source">
+
+
+
+ <div class="method-source-code"
+ id="fact-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 405</span>
405: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fact_filter</span>(<span class="ruby-identifier">fact</span>, <span class="ruby-identifier">value</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">operator</span>=<span class="ruby-value str">"="</span>)
416:
417: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"fact"</span>].<span class="ruby-identifier">compact!</span>
418: <span class="ruby-identifier">reset</span>
-419: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000114" class="method-detail">
- <a name="M000114"></a>
-
- <div class="method-heading">
- <a href="#M000114" class="method-signature">
- <span class="method-name">fire_and_forget_request</span><span class="method-args">(action, args, filter=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+419: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="fire-and-forget-request-method" class="method-detail ">
+ <a name="M000477"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">fire_and_forget_request</span><span
+ class="method-args">(action, args, filter=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
for requests that do not care for results just return the request id and
-don‘t do any of the response processing.
+don’t do any of the response processing.
</p>
<p>
We send the :process_results flag with to the nodes so they can make
decisions based on that.
</p>
<p>
-Should only be called via <a href="Client.html#M000090">method_missing</a>
+Should only be called via <a href="Client.html#M000452">method_missing</a>
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000114-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000114-source">
+
+
+
+ <div class="method-source-code"
+ id="fire-and-forget-request-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 710</span>
710: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fire_and_forget_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">filter</span>=<span class="ruby-keyword kw">nil</span>)
725: <span class="ruby-keyword kw">end</span>
726:
727: <span class="ruby-identifier">client</span>.<span class="ruby-identifier">sendreq</span>(<span class="ruby-identifier">message</span>, <span class="ruby-keyword kw">nil</span>)
-728: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000087" class="method-detail">
- <a name="M000087"></a>
-
- <div class="method-heading">
- <a href="#M000087" class="method-signature">
- <span class="method-name">help</span><span class="method-args">(template)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns <a href="Client.html#M000087">help</a> for an agent if a <a
-href="../DDL.html">DDL</a> was found
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000087-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000087-source">
+728: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="help-method" class="method-detail ">
+ <a name="M000447"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">help</span><span
+ class="method-args">(template)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns help for an agent if a <a href="../DDL.html">DDL</a> was found
+</p>
+
+
+
+ <div class="method-source-code"
+ id="help-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 126</span>
126: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">help</span>(<span class="ruby-identifier">template</span>)
127: <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">help</span>(<span class="ruby-identifier">template</span>)
-128: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000099" class="method-detail">
- <a name="M000099"></a>
-
- <div class="method-heading">
- <a href="#M000099" class="method-signature">
- <span class="method-name">identity_filter</span><span class="method-args">(identity)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+128: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="identity-filter-method" class="method-detail ">
+ <a name="M000462"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">identity_filter</span><span
+ class="method-args">(identity)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Sets the identity filter
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000099-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000099-source">
+
+
+
+ <div class="method-source-code"
+ id="identity-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 429</span>
429: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">identity_filter</span>(<span class="ruby-identifier">identity</span>)
430: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"identity"</span>] = <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"identity"</span>] <span class="ruby-operator">|</span> [<span class="ruby-identifier">identity</span>]
431: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"identity"</span>].<span class="ruby-identifier">compact!</span>
432: <span class="ruby-identifier">reset</span>
-433: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000115" class="method-detail">
- <a name="M000115"></a>
-
- <div class="method-heading">
- <a href="#M000115" class="method-signature">
- <span class="method-name">identity_filter_discovery_optimization</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+433: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="identity-filter-discovery-optimization-method" class="method-detail ">
+ <a name="M000478"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">identity_filter_discovery_optimization</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
if an identity filter is supplied and it is all strings no regex we can use
that as discovery data, technically the identity filter is then redundant
if we are in direct addressing mode and we could empty it out but this use
-case should only really be for a few -I‘s on the CLI
+case should only really be for a few -I’s on the CLI
</p>
<p>
For safety we leave the filter in place for now, that way we can support
methods might change the concept of identity to mean something else so we
should pass the full identity filter to them
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000115-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000115-source">
+
+
+
+ <div class="method-source-code"
+ id="identity-filter-discovery-optimization-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 741</span>
741: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">identity_filter_discovery_optimization</span>
747: <span class="ruby-ivar">@force_direct_request</span> = <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">direct_addressing</span>
748: <span class="ruby-keyword kw">end</span>
749: <span class="ruby-keyword kw">end</span>
-750: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000107" class="method-detail">
- <a name="M000107"></a>
-
- <div class="method-heading">
- <a href="#M000107" class="method-signature">
- <span class="method-name">limit_method=</span><span class="method-args">(method)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets and sanity check the limit_method variable used to determine how to
-limit targets if limit_targets is set
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000107-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000107-source">
+750: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="limit-method--method" class="method-detail ">
+ <a name="M000470"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">limit_method=</span><span
+ class="method-args">(method)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sets and sanity check the <a
+href="Client.html#limit_method">limit_method</a> variable used to determine
+how to limit targets if <a
+href="Client.html#limit_targets">limit_targets</a> is set
+</p>
+
+
+
+ <div class="method-source-code"
+ id="limit-method--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 599</span>
599: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">limit_method=</span>(<span class="ruby-identifier">method</span>)
602: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Unknown limit method #{method} must be :random or :first"</span> <span class="ruby-keyword kw">unless</span> [<span class="ruby-identifier">:random</span>, <span class="ruby-identifier">:first</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">method</span>)
603:
604: <span class="ruby-ivar">@limit_method</span> = <span class="ruby-identifier">method</span>
-605: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000106" class="method-detail">
- <a name="M000106"></a>
-
- <div class="method-heading">
- <a href="#M000106" class="method-signature">
- <span class="method-name">limit_targets=</span><span class="method-args">(limit)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets and sanity checks the limit_targets variable used to restrict how many
-nodes we‘ll target
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000106-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000106-source">
+605: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="limit-targets--method" class="method-detail ">
+ <a name="M000469"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">limit_targets=</span><span
+ class="method-args">(limit)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sets and sanity checks the <a
+href="Client.html#limit_targets">limit_targets</a> variable used to
+restrict how many nodes we’ll target
+</p>
+
+
+
+ <div class="method-source-code"
+ id="limit-targets--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 583</span>
583: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">limit_targets=</span>(<span class="ruby-identifier">limit</span>)
592: <span class="ruby-keyword kw">else</span>
593: <span class="ruby-ivar">@limit_targets</span> = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">limit</span>)
594: <span class="ruby-keyword kw">end</span>
-595: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000111" class="method-detail">
- <a name="M000111"></a>
-
- <div class="method-heading">
- <a href="#M000111" class="method-signature">
- <span class="method-name">load_aggregate_functions</span><span class="method-args">(action, ddl)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000111-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000111-source">
+595: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="load-aggregate-functions-method" class="method-detail ">
+ <a name="M000474"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_aggregate_functions</span><span
+ class="method-args">(action, ddl)</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="load-aggregate-functions-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 676</span>
676: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_aggregate_functions</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">ddl</span>)
682: <span class="ruby-keyword kw">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
683: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-value str">"Failed to load aggregate functions, calculating summaries disabled: %s: %s (%s)"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">first</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>])
684: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
-685: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000090" class="method-detail">
- <a name="M000090"></a>
-
- <div class="method-heading">
- <a href="#M000090" class="method-signature">
- <span class="method-name">method_missing</span><span class="method-args">(method_name, *args, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+685: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="method-missing-method" class="method-detail ">
+ <a name="M000452"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">method_missing</span><span
+ class="method-args">(method_name, *args, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Magic handler to invoke remote methods
</p>
<p>
Once the stub is created using the constructor or the <a
-href="../RPC.html#M000037">RPC#rpcclient</a> helper you can call remote
+href="../RPC.html#M000314">RPC#rpcclient</a> helper you can call remote
actions easily:
</p>
<pre>
<p>
This will call the ‘echo’ action of the ‘rpctest’
agent and return the result as an array, the array will be a simplified
-result set from the usual full MCollective::Client#req with additional
+result set from the usual full <a
+href="../Client.html#M000503">MCollective::Client#req</a> with additional
error codes and error text:
</p>
<p>
}
</p>
<p>
-If :statuscode is 0 then everything went find, if it‘s 1 then you
+If :statuscode is 0 then everything went find, if it’s 1 then you
supplied the correct arguments etc but the request could not be completed,
-you‘ll find a human parsable reason in :statusmsg then.
+you’ll find a human parsable reason in :statusmsg then.
</p>
<p>
Codes 2 to 5 maps directly to <a
failure.
</p>
<p>
-To get access to the full result of the MCollective::Client#req calls you
-can pass in a block:
+To get access to the full result of the <a
+href="../Client.html#M000503">MCollective::Client#req</a> calls you can
+pass in a block:
</p>
<pre>
rpc.echo(:msg => "hello world") do |resp|
end
</pre>
<p>
-In this case resp will the result from MCollective::Client#req. Instead of
-returning simple text and codes as above you‘ll also need to handle
+In this case resp will the result from <a
+href="../Client.html#M000503">MCollective::Client#req</a>. Instead of
+returning simple text and codes as above you’ll also need to handle
the following exceptions:
</p>
<p>
</p>
<p>
During calls a progress indicator will be shown of how many results
-we‘ve received against how many nodes were discovered, you can
+we’ve received against how many nodes were discovered, you can
disable this by setting progress to false:
</p>
<pre>
</pre>
<p>
This supports a 2nd mode where it will send the SimpleRPC request and never
-handle the responses. It‘s a bit like UDP, it sends the request with
+handle the responses. It’s a bit like UDP, it sends the request with
the filter attached and you only get back the requestid, you have no
indication about results.
</p>
This will do everything exactly as normal but communicate to only 5 agents
at a time
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000090-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000090-source">
+
+
+
+ <div class="method-source-code"
+ id="method-missing-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 231</span>
231: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method_name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
263: <span class="ruby-keyword kw">else</span>
264: <span class="ruby-identifier">call_agent</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">options</span>, <span class="ruby-identifier">:auto</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
265: <span class="ruby-keyword kw">end</span>
-266: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000088" class="method-detail">
- <a name="M000088"></a>
-
- <div class="method-heading">
- <a href="#M000088" class="method-signature">
- <span class="method-name">new_request</span><span class="method-args">(action, data)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+266: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="new-request-method" class="method-detail ">
+ <a name="M000448"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new_request</span><span
+ class="method-args">(action, data)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Creates a suitable request hash for the SimpleRPC agent.
</p>
<p>
-You‘d use this if you ever wanted to take care of sending requests on
-your own - perhaps via Client#sendreq if you didn‘t care for
+You’d use this if you ever wanted to take care of sending requests on
+your own - perhaps via Client#sendreq if you didn’t care for
responses.
</p>
<p>
Clearly the use of this technique should be limited and done only if your
code requires such a thing
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000088-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000088-source">
+
+
+
+ <div class="method-source-code"
+ id="new-request-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 149</span>
149: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">new_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">data</span>)
155: <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">action</span>,
156: <span class="ruby-identifier">:caller</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">callerid</span>,
157: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">data</span>}
-158: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000104" class="method-detail">
- <a name="M000104"></a>
-
- <div class="method-heading">
- <a href="#M000104" class="method-signature">
- <span class="method-name">options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Provides a normal <a href="Client.html#M000104">options</a> hash like you
-would get from <a href="../Optionparser.html">Optionparser</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000104-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000104-source">
+158: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="options-method" class="method-detail ">
+ <a name="M000467"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Provides a normal options hash like you would get from <a
+href="../Optionparser.html">Optionparser</a>
+</p>
+
+
+
+ <div class="method-source-code"
+ id="options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 556</span>
556: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">options</span>
567: <span class="ruby-identifier">:config</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@config</span>,
568: <span class="ruby-identifier">:publish_timeout</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@publish_timeout</span>,
569: <span class="ruby-identifier">:threaded</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@threaded</span>}
-570: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000110" class="method-detail">
- <a name="M000110"></a>
-
- <div class="method-heading">
- <a href="#M000110" class="method-signature">
- <span class="method-name">pick_nodes_from_discovered</span><span class="method-args">(count)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+570: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="pick-nodes-from-discovered-method" class="method-detail ">
+ <a name="M000473"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">pick_nodes_from_discovered</span><span
+ class="method-args">(count)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Pick a number of nodes from the discovered nodes
</p>
<p>
- if random chosen, and batch-seed set, then set srand
for the generator, and reset afterwards
</pre>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000110-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000110-source">
+
+
+
+ <div class="method-source-code"
+ id="pick-nodes-from-discovered-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 635</span>
635: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pick_nodes_from_discovered</span>(<span class="ruby-identifier">count</span>)
671: <span class="ruby-keyword kw">end</span>
672:
673: [<span class="ruby-identifier">result</span>].<span class="ruby-identifier">flatten</span>
-674: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000119" class="method-detail">
- <a name="M000119"></a>
-
- <div class="method-heading">
- <a href="#M000119" class="method-signature">
- <span class="method-name">process_results_with_block</span><span class="method-args">(action, resp, block, aggregate)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+674: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="process-results-with-block-method" class="method-detail ">
+ <a name="M000485"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">process_results_with_block</span><span
+ class="method-args">(action, resp, block, aggregate)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
process client requests by calling a block on each result in this mode we
do not do anything fancy with the result objects and we raise exceptions if
there are problems with the data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000119-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000119-source">
+
+
+
+ <div class="method-source-code"
+ id="process-results-with-block-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 944</span>
944: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">process_results_with_block</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">resp</span>, <span class="ruby-identifier">block</span>, <span class="ruby-identifier">aggregate</span>)
976: <span class="ruby-keyword kw">end</span>
977:
978: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">aggregate</span>
-979: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000118" class="method-detail">
- <a name="M000118"></a>
-
- <div class="method-heading">
- <a href="#M000118" class="method-signature">
- <span class="method-name">process_results_without_block</span><span class="method-args">(resp, action, aggregate)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+979: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="process-results-without-block-method" class="method-detail ">
+ <a name="M000481"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">process_results_without_block</span><span
+ class="method-args">(resp, action, aggregate)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Handles result sets that has no block associated, sets fails and ok in the
stats object and return a hash of the response to send to the caller
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000118-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000118-source">
+
+
+
+ <div class="method-source-code"
+ id="process-results-without-block-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 924</span>
924: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">process_results_without_block</span>(<span class="ruby-identifier">resp</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">aggregate</span>)
935: <span class="ruby-keyword kw">end</span>
936:
937: [<span class="ruby-identifier">result</span>, <span class="ruby-identifier">aggregate</span>]
-938: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000101" class="method-detail">
- <a name="M000101"></a>
-
- <div class="method-heading">
- <a href="#M000101" class="method-signature">
- <span class="method-name">reset</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+938: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="reset-method" class="method-detail ">
+ <a name="M000464"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">reset</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Resets various internal parts of the class, most importantly it clears out
the cached discovery
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000101-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000101-source">
+
+
+
+ <div class="method-source-code"
+ id="reset-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 443</span>
443: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset</span>
444: <span class="ruby-ivar">@discovered_agents</span> = <span class="ruby-keyword kw">nil</span>
-445: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000102" class="method-detail">
- <a name="M000102"></a>
-
- <div class="method-heading">
- <a href="#M000102" class="method-signature">
- <span class="method-name">reset_filter</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+445: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="reset-filter-method" class="method-detail ">
+ <a name="M000465"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">reset_filter</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Reet the filter to an empty one
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000102-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000102-source">
+
+
+
+ <div class="method-source-code"
+ id="reset-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 448</span>
448: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset_filter</span>
449: <span class="ruby-ivar">@filter</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter</span>
450: <span class="ruby-identifier">agent_filter</span> <span class="ruby-ivar">@agent</span>
-451: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000113" class="method-detail">
- <a name="M000113"></a>
-
- <div class="method-heading">
- <a href="#M000113" class="method-signature">
- <span class="method-name">rpc_result_from_reply</span><span class="method-args">(agent, action, reply)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000113-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000113-source">
+451: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rpc-result-from-reply-method" class="method-detail ">
+ <a name="M000476"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rpc_result_from_reply</span><span
+ class="method-args">(agent, action, reply)</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="rpc-result-from-reply-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 697</span>
697: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rpc_result_from_reply</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">reply</span>)
698: <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">action</span>, {<span class="ruby-identifier">:sender</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:senderid</span>], <span class="ruby-identifier">:statuscode</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:statuscode</span>],
699: <span class="ruby-identifier">:statusmsg</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:statusmsg</span>], <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:data</span>]})
-700: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000089" class="method-detail">
- <a name="M000089"></a>
-
- <div class="method-heading">
- <a href="#M000089" class="method-signature">
- <span class="method-name">validate_request</span><span class="method-args">(action, args)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+700: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-request-method" class="method-detail ">
+ <a name="M000449"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate_request</span><span
+ class="method-args">(action, args)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
For the provided arguments and action the input arguments get modified by
supplying any defaults provided in the <a href="../DDL.html">DDL</a> for
arguments that were not supplied in the request
We then pass the modified arguments to the <a href="../DDL.html">DDL</a>
for validation
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000089-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000089-source">
+
+
+
+ <div class="method-source-code"
+ id="validate-request-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/client.rb, line 165</span>
165: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>)
167:
168: <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">set_default_input_arguments</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>)
169: <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">validate_rpc_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>)
-170: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+170: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </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>
-</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>
\ No newline at end of file
+</html>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>Class: MCollective::RPC::Helpers</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::Helpers</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/helpers_rb.html">
- lib/mcollective/rpc/helpers.rb
- </a>
- <br />
- </td>
- </tr>
+ <title>Class: MCollective::RPC::Helpers</title>
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
+ <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
- <div id="bodyContent">
+ <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>
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
+</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/rpc/helpers_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/helpers.rb">lib/mcollective/rpc/helpers.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="#M000453">::add_simplerpc_options</a></li>
+
+ <li><a href="#M000442">::extract_hosts_from_array</a></li>
+
+ <li><a href="#M000441">::extract_hosts_from_json</a></li>
+
+ <li><a href="#M000451">::old_rpcresults</a></li>
+
+ <li><a href="#M000444">::rpcresults</a></li>
+
+ <li><a href="#M000450">::text_for_flattened_result</a></li>
+
+ <li><a href="#M000445">::text_for_result</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::RPC::Helpers</h1>
+
+ <div id="description">
+ <p>
Various utilities for the <a href="../RPC.html">RPC</a> system
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000050">add_simplerpc_options</a>
- <a href="#M000045">extract_hosts_from_array</a>
- <a href="#M000044">extract_hosts_from_json</a>
- <a href="#M000049">old_rpcresults</a>
- <a href="#M000046">rpcresults</a>
- <a href="#M000048">text_for_flattened_result</a>
- <a href="#M000047">text_for_result</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
+ </div>
+ <!-- Constants -->
+
+ <!-- Attributes -->
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
-
+
+ <div id="add-simplerpc-options-method" class="method-detail ">
+ <a name="M000453"></a>
+ <div class="method-heading">
+
+ <span class="method-name">add_simplerpc_options</span><span
+ class="method-args">(parser, options)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000050" class="method-detail">
- <a name="M000050"></a>
-
- <div class="method-heading">
- <a href="#M000050" class="method-signature">
- <span class="method-name">add_simplerpc_options</span><span class="method-args">(parser, options)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+ <div class="method-description">
+
+ <p>
Add SimpleRPC common options
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000050-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000050-source">
+
+
+
+ <div class="method-source-code"
+ id="add-simplerpc-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 254</span>
254: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">add_simplerpc_options</span>(<span class="ruby-identifier">parser</span>, <span class="ruby-identifier">options</span>)
300:
301: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"--display has to be one of 'ok', 'all' or 'failed'"</span> <span class="ruby-keyword kw">unless</span> [<span class="ruby-identifier">:ok</span>, <span class="ruby-identifier">:failed</span>, <span class="ruby-identifier">:always</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:force_display_mode</span>])
302: <span class="ruby-keyword kw">end</span>
-303: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000045" class="method-detail">
- <a name="M000045"></a>
-
- <div class="method-heading">
- <a href="#M000045" class="method-signature">
- <span class="method-name">extract_hosts_from_array</span><span class="method-args">(hosts)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+303: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="extract-hosts-from-array-method" class="method-detail ">
+ <a name="M000442"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">extract_hosts_from_array</span><span
+ class="method-args">(hosts)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Given an array of something, make sure each is a string chomp off any new
lines and return just the array of hosts
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000045-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000045-source">
+
+
+
+ <div class="method-source-code"
+ id="extract-hosts-from-array-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 29</span>
29: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">extract_hosts_from_array</span>(<span class="ruby-identifier">hosts</span>)
31: <span class="ruby-identifier">raise</span> <span class="ruby-node">"#{host} should be a string"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">host</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
32: <span class="ruby-identifier">host</span>.<span class="ruby-identifier">chomp</span>
33: <span class="ruby-keyword kw">end</span>
-34: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000044" class="method-detail">
- <a name="M000044"></a>
-
- <div class="method-heading">
- <a href="#M000044" class="method-signature">
- <span class="method-name">extract_hosts_from_json</span><span class="method-args">(json)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+34: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="extract-hosts-from-json-method" class="method-detail ">
+ <a name="M000441"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">extract_hosts_from_json</span><span
+ class="method-args">(json)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Parse JSON output as produced by printrpc and extract the
-"sender" of each rpc response
+“sender” of each rpc response
</p>
<p>
The simplist valid JSON based data would be:
<p>
]
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000044-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000044-source">
+
+
+
+ <div class="method-source-code"
+ id="extract-hosts-from-json-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 14</span>
14: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">extract_hosts_from_json</span>(<span class="ruby-identifier">json</span>)
22:
23: <span class="ruby-identifier">host</span>[<span class="ruby-value str">"sender"</span>]
24: <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">uniq</span>
-25: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000049" class="method-detail">
- <a name="M000049"></a>
-
- <div class="method-heading">
- <a href="#M000049" class="method-signature">
- <span class="method-name">old_rpcresults</span><span class="method-args">(result, flags = {})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+25: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="old-rpcresults-method" class="method-detail ">
+ <a name="M000451"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">old_rpcresults</span><span
+ class="method-args">(result, flags = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Backward compatible display block for results without a <a
href="../DDL.html">DDL</a>
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000049-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000049-source">
+
+
+
+ <div class="method-source-code"
+ id="old-rpcresults-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 202</span>
202: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">old_rpcresults</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">flags</span> = {})
248: <span class="ruby-keyword kw">end</span>
249:
250: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">""</span>
-251: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000046" class="method-detail">
- <a name="M000046"></a>
-
- <div class="method-heading">
- <a href="#M000046" class="method-signature">
- <span class="method-name">rpcresults</span><span class="method-args">(result, flags = {})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+251: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rpcresults-method" class="method-detail ">
+ <a name="M000444"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rpcresults</span><span
+ class="method-args">(result, flags = {})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns a blob of text representing the results in a standard way
</p>
<p>
printrpc exim.mailq, :verbose => true
</pre>
<p>
-If you‘ve asked it to flatten the result it will not print sender
-hostnames, it will just print the result as if it‘s one huge result,
+If you’ve asked it to flatten the result it will not print sender
+hostnames, it will just print the result as if it’s one huge result,
handy for things like showing a combined mailq.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000046-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000046-source">
+
+
+
+ <div class="method-source-code"
+ id="rpcresults-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 54</span>
54: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">rpcresults</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">flags</span> = {})
113: <span class="ruby-keyword kw">end</span>
114:
115: <span class="ruby-identifier">result_text</span>
-116: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000048" class="method-detail">
- <a name="M000048"></a>
-
- <div class="method-heading">
- <a href="#M000048" class="method-signature">
- <span class="method-name">text_for_flattened_result</span><span class="method-args">(status, result)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+116: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="text-for-flattened-result-method" class="method-detail ">
+ <a name="M000450"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">text_for_flattened_result</span><span
+ class="method-args">(status, result)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns text representing a flattened result of only good data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000048-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000048-source">
+
+
+
+ <div class="method-source-code"
+ id="text-for-flattened-result-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 189</span>
189: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">text_for_flattened_result</span>(<span class="ruby-identifier">status</span>, <span class="ruby-identifier">result</span>)
196: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">result</span>
197: <span class="ruby-keyword kw">end</span>
198: <span class="ruby-keyword kw">end</span>
-199: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000047" class="method-detail">
- <a name="M000047"></a>
-
- <div class="method-heading">
- <a href="#M000047" class="method-signature">
- <span class="method-name">text_for_result</span><span class="method-args">(sender, status, msg, result, ddl)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+199: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="text-for-result-method" class="method-detail ">
+ <a name="M000445"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">text_for_result</span><span
+ class="method-args">(sender, status, msg, result, ddl)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Return text representing a result
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000047-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000047-source">
+
+
+
+ <div class="method-source-code"
+ id="text-for-result-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/helpers.rb, line 119</span>
119: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">text_for_result</span>(<span class="ruby-identifier">sender</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">result</span>, <span class="ruby-identifier">ddl</span>)
183:
184: <span class="ruby-identifier">result_text</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"\n"</span>
185: <span class="ruby-identifier">result_text</span>
-186: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+186: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </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>
-</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>
\ No newline at end of file
+</html>
+
--- /dev/null
+<?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::RPC::Progress</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/rpc/progress_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/progress.rb">lib/mcollective/rpc/progress.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="#M000391">::new</a></li>
+
+ <li><a href="#M000392">#twirl</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::RPC::Progress</h1>
+
+ <div id="description">
+ <p>
+Class that shows a progress bar, currently only supports a twirling
+progress bar.
+</p>
+<p>
+You can specify a size for the progress bar if you want if you dont it will
+use the helper functions to figure out terminal dimensions and draw an
+appropriately sized bar
+</p>
+<p>
+p = <a href="Progress.html#M000391">Progress.new</a> 100.times {|i| print
+p.twirl(i+1, 100) + “r“};puts
+</p>
+<pre>
+ * [ ==================================================> ] 100 / 100
+</pre>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- 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="M000391"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(size=nil)</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/rpc/progress.rb, line 15</span>
+15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">size</span>=<span class="ruby-keyword kw">nil</span>)
+16: <span class="ruby-ivar">@twirl</span> = [<span class="ruby-value str">'|'</span>, <span class="ruby-value str">'/'</span>, <span class="ruby-value str">'-'</span>, <span class="ruby-value str">"\\"</span>, <span class="ruby-value str">'|'</span>, <span class="ruby-value str">'/'</span>, <span class="ruby-value str">'-'</span>, <span class="ruby-value str">"\\"</span>]
+17: <span class="ruby-ivar">@twirldex</span> = <span class="ruby-value">0</span>
+18:
+19: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">size</span>
+20: <span class="ruby-ivar">@size</span> = <span class="ruby-identifier">size</span>
+21: <span class="ruby-keyword kw">else</span>
+22: <span class="ruby-identifier">cols</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">terminal_dimensions</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">-</span> <span class="ruby-value">22</span>
+23:
+24: <span class="ruby-comment cmt"># Defaults back to old behavior if it</span>
+25: <span class="ruby-comment cmt"># couldn't figure out the size or if</span>
+26: <span class="ruby-comment cmt"># its more than 60 wide</span>
+27: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">cols</span> <span class="ruby-operator"><=</span> <span class="ruby-value">0</span>
+28: <span class="ruby-ivar">@size</span> = <span class="ruby-value">0</span>
+29: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">cols</span> <span class="ruby-operator">></span> <span class="ruby-value">60</span>
+30: <span class="ruby-ivar">@size</span> = <span class="ruby-value">60</span>
+31: <span class="ruby-keyword kw">else</span>
+32: <span class="ruby-ivar">@size</span> = <span class="ruby-identifier">cols</span>
+33: <span class="ruby-keyword kw">end</span>
+34: <span class="ruby-keyword kw">end</span>
+35: <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="twirl-method" class="method-detail ">
+ <a name="M000392"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">twirl</span><span
+ class="method-args">(current, total)</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="twirl-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/progress.rb, line 37</span>
+37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">twirl</span>(<span class="ruby-identifier">current</span>, <span class="ruby-identifier">total</span>)
+38: <span class="ruby-comment cmt"># if the size is negative there is just not enough</span>
+39: <span class="ruby-comment cmt"># space on the terminal, return a simpler version</span>
+40: <span class="ruby-keyword kw">return</span> <span class="ruby-node">"\r#{current} / #{total}"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+41:
+42: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">current</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">total</span>
+43: <span class="ruby-identifier">txt</span> = <span class="ruby-value str">"\r %s [ "</span> <span class="ruby-operator">%</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:green</span>, <span class="ruby-value str">"*"</span>)
+44: <span class="ruby-keyword kw">else</span>
+45: <span class="ruby-identifier">txt</span> = <span class="ruby-value str">"\r %s [ "</span> <span class="ruby-operator">%</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-ivar">@twirl</span>[<span class="ruby-ivar">@twirldex</span>])
+46: <span class="ruby-keyword kw">end</span>
+47:
+48: <span class="ruby-identifier">dashes</span> = ((<span class="ruby-identifier">current</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">total</span>) <span class="ruby-operator">*</span> <span class="ruby-ivar">@size</span>).<span class="ruby-identifier">round</span>
+49:
+50: <span class="ruby-identifier">dashes</span>.<span class="ruby-identifier">times</span> { <span class="ruby-identifier">txt</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"="</span> }
+51: <span class="ruby-identifier">txt</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">">"</span>
+52:
+53: (<span class="ruby-ivar">@size</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">dashes</span>).<span class="ruby-identifier">times</span> { <span class="ruby-identifier">txt</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" "</span> }
+54:
+55: <span class="ruby-identifier">txt</span> <span class="ruby-operator"><<</span> <span class="ruby-node">" ] #{current} / #{total}"</span>
+56:
+57: <span class="ruby-ivar">@twirldex</span> <span class="ruby-operator">==</span> <span class="ruby-value">7</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@twirldex</span> = <span class="ruby-value">0</span> <span class="ruby-operator">:</span> <span class="ruby-ivar">@twirldex</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+58:
+59: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">txt</span>
+60: <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>
+
--- /dev/null
+<?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::RPC::Reply</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/rpc/reply_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/reply.rb">lib/mcollective/rpc/reply.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="#M000383">::new</a></li>
+
+ <li><a href="#M000388">#[]</a></li>
+
+ <li><a href="#M000387">#[]=</a></li>
+
+ <li><a href="#M000385">#fail</a></li>
+
+ <li><a href="#M000386">#fail!</a></li>
+
+ <li><a href="#M000389">#fetch</a></li>
+
+ <li><a href="#M000384">#initialize_data</a></li>
+
+ <li><a href="#M000390">#to_hash</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::RPC::Reply</h1>
+
+ <div id="description">
+ <p>
+Simple class to manage compliant replies to <a
+href="../RPC.html">MCollective::RPC</a>
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="statuscode-attribute-method" class="method-detail">
+ <a name="statuscode"></a>
+
+ <a name="statuscode="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">statuscode</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="statusmsg-attribute-method" class="method-detail">
+ <a name="statusmsg"></a>
+
+ <a name="statusmsg="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">statusmsg</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="data-attribute-method" class="method-detail">
+ <a name="data"></a>
+
+ <a name="data="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">data</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="M000383"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(action, ddl)</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/rpc/reply.rb, line 7</span>
+ 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">ddl</span>)
+ 8: <span class="ruby-ivar">@data</span> = {}
+ 9: <span class="ruby-ivar">@statuscode</span> = <span class="ruby-value">0</span>
+10: <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-value str">"OK"</span>
+11: <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">ddl</span>
+12: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
+13:
+14: <span class="ruby-keyword kw">begin</span>
+15: <span class="ruby-identifier">initialize_data</span>
+16: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+17: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-value str">"Could not pre-populate reply data from the DDL: %s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span> ])
+18: <span class="ruby-keyword kw">end</span>
+19: <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="--method" class="method-detail ">
+ <a name="M000388"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(key)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Read from the data hash
+</p>
+
+
+
+ <div class="method-source-code"
+ id="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 70</span>
+70: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
+71: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>]
+72: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000387"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]=</span><span
+ class="method-args">(key, val)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Write to the data hash
+</p>
+
+
+
+ <div class="method-source-code"
+ id="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 65</span>
+65: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span>)
+66: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">val</span>
+67: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="fail-method" class="method-detail ">
+ <a name="M000385"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">fail</span><span
+ class="method-args">(msg, code=1)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Helper to fill in statusmsg and code on failure
+</p>
+
+
+
+ <div class="method-source-code"
+ id="fail-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 36</span>
+36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fail</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">code</span>=<span class="ruby-value">1</span>)
+37: <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-identifier">msg</span>
+38: <span class="ruby-ivar">@statuscode</span> = <span class="ruby-identifier">code</span>
+39: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="fail--method" class="method-detail ">
+ <a name="M000386"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">fail!</span><span
+ class="method-args">(msg, code=1)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Helper that fills in statusmsg and code but also raises an appropriate
+error
+</p>
+
+
+
+ <div class="method-source-code"
+ id="fail--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 42</span>
+42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fail!</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">code</span>=<span class="ruby-value">1</span>)
+43: <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-identifier">msg</span>
+44: <span class="ruby-ivar">@statuscode</span> = <span class="ruby-identifier">code</span>
+45:
+46: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">code</span>
+47: <span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span>
+48: <span class="ruby-identifier">raise</span> <span class="ruby-constant">RPCAborted</span>, <span class="ruby-identifier">msg</span>
+49:
+50: <span class="ruby-keyword kw">when</span> <span class="ruby-value">2</span>
+51: <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownRPCAction</span>, <span class="ruby-identifier">msg</span>
+52:
+53: <span class="ruby-keyword kw">when</span> <span class="ruby-value">3</span>
+54: <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingRPCData</span>, <span class="ruby-identifier">msg</span>
+55:
+56: <span class="ruby-keyword kw">when</span> <span class="ruby-value">4</span>
+57: <span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidRPCData</span>, <span class="ruby-identifier">msg</span>
+58:
+59: <span class="ruby-keyword kw">else</span>
+60: <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownRPCError</span>, <span class="ruby-identifier">msg</span>
+61: <span class="ruby-keyword kw">end</span>
+62: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="fetch-method" class="method-detail ">
+ <a name="M000389"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">fetch</span><span
+ class="method-args">(key, default)</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="fetch-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 74</span>
+74: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
+75: <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
+76: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="initialize-data-method" class="method-detail ">
+ <a name="M000384"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">initialize_data</span><span
+ class="method-args">()</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="initialize-data-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 21</span>
+21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize_data</span>
+22: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">actions</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@action</span>)
+23: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No action '%s' defined for agent '%s' in the DDL"</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@action</span>, <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">pluginname</span>]
+24: <span class="ruby-keyword kw">end</span>
+25:
+26: <span class="ruby-identifier">interface</span> = <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">action_interface</span>(<span class="ruby-ivar">@action</span>)
+27:
+28: <span class="ruby-identifier">interface</span>[<span class="ruby-identifier">:output</span>].<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span><span class="ruby-operator">|</span>
+29: <span class="ruby-comment cmt"># must deep clone this data to avoid accidental updates of the DDL in cases where the</span>
+30: <span class="ruby-comment cmt"># default is for example a string and someone does << on it</span>
+31: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">output</span>] = <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">interface</span>[<span class="ruby-identifier">:output</span>][<span class="ruby-identifier">output</span>].<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:default</span>, <span class="ruby-keyword kw">nil</span>)))
+32: <span class="ruby-keyword kw">end</span>
+33: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="to-hash-method" class="method-detail ">
+ <a name="M000390"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">to_hash</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns a compliant Hash of the reply that should be sent over the
+middleware
+</p>
+
+
+
+ <div class="method-source-code"
+ id="to-hash-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 80</span>
+80: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
+81: <span class="ruby-keyword kw">return</span> {<span class="ruby-identifier">:statuscode</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@statuscode</span>,
+82: <span class="ruby-identifier">:statusmsg</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@statusmsg</span>,
+83: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@data</span>}
+84: <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>
+
--- /dev/null
+<?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::RPC::Request</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/rpc/request_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/request.rb">lib/mcollective/rpc/request.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="#M000396">::new</a></li>
+
+ <li><a href="#M000399">#[]</a></li>
+
+ <li><a href="#M000400">#fetch</a></li>
+
+ <li><a href="#M000397">#include?</a></li>
+
+ <li><a href="#M000398">#should_respond?</a></li>
+
+ <li><a href="#M000401">#to_hash</a></li>
+
+ <li><a href="#M000403">#to_json</a></li>
+
+ <li><a href="#M000402">#validate!</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::RPC::Request</h1>
+
+ <div id="description">
+ <p>
+Simple class to manage compliant requests for <a
+href="../RPC.html">MCollective::RPC</a> agents
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="time-attribute-method" class="method-detail">
+ <a name="time"></a>
+
+ <a name="time="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">time</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="action-attribute-method" class="method-detail">
+ <a name="action"></a>
+
+ <a name="action="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">action</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="data-attribute-method" class="method-detail">
+ <a name="data"></a>
+
+ <a name="data="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">data</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="sender-attribute-method" class="method-detail">
+ <a name="sender"></a>
+
+ <a name="sender="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">sender</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="agent-attribute-method" class="method-detail">
+ <a name="agent"></a>
+
+ <a name="agent="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">agent</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="uniqid-attribute-method" class="method-detail">
+ <a name="uniqid"></a>
+
+ <a name="uniqid="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">uniqid</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="caller-attribute-method" class="method-detail">
+ <a name="caller"></a>
+
+ <a name="caller="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">caller</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ddl-attribute-method" class="method-detail">
+ <a name="ddl"></a>
+
+ <a name="ddl="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ddl</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="M000396"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(msg, ddl)</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/rpc/request.rb, line 7</span>
+ 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">ddl</span>)
+ 8: <span class="ruby-ivar">@time</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:msgtime</span>]
+ 9: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:action</span>]
+10: <span class="ruby-ivar">@data</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:data</span>]
+11: <span class="ruby-ivar">@sender</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:senderid</span>]
+12: <span class="ruby-ivar">@agent</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:agent</span>]
+13: <span class="ruby-ivar">@uniqid</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:requestid</span>]
+14: <span class="ruby-ivar">@caller</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:callerid</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">"unknown"</span>
+15: <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">ddl</span>
+16: <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="--method" class="method-detail ">
+ <a name="M000399"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(key)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+If data is a hash, gives easy access to its members, else returns nil
+</p>
+
+
+
+ <div class="method-source-code"
+ id="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 34</span>
+34: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
+35: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
+36: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>]
+37: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="fetch-method" class="method-detail ">
+ <a name="M000400"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">fetch</span><span
+ class="method-args">(key, default)</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="fetch-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 39</span>
+39: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
+40: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
+41: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
+42: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="include--method" class="method-detail ">
+ <a name="M000397"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">include?</span><span
+ class="method-args">(key)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+If data is a hash, quick helper to get access to it’s include? method
+else returns false
+</p>
+
+
+
+ <div class="method-source-code"
+ id="include--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 20</span>
+20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
+21: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
+22: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
+23: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="should-respond--method" class="method-detail ">
+ <a name="M000398"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">should_respond?</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+If no :process_results is specified always respond else respond based on
+the supplied property
+</p>
+
+
+
+ <div class="method-source-code"
+ id="should-respond--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 27</span>
+27: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">should_respond?</span>
+28: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">:process_results</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:process_results</span>)
+29:
+30: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+31: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="to-hash-method" class="method-detail ">
+ <a name="M000401"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">to_hash</span><span
+ class="method-args">()</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="to-hash-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 44</span>
+44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
+45: <span class="ruby-keyword kw">return</span> {<span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@agent</span>,
+46: <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@action</span>,
+47: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@data</span>}
+48: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="to-json-method" class="method-detail ">
+ <a name="M000403"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">to_json</span><span
+ class="method-args">()</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="to-json-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 55</span>
+55: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_json</span>
+56: <span class="ruby-identifier">to_hash</span>.<span class="ruby-identifier">merge!</span>({<span class="ruby-identifier">:sender</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@sender</span>,
+57: <span class="ruby-identifier">:callerid</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@callerid</span>,
+58: <span class="ruby-identifier">:uniqid</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@uniqid</span>}).<span class="ruby-identifier">to_json</span>
+59: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate--method" class="method-detail ">
+ <a name="M000402"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate!</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Validate the request against the <a href="../DDL.html">DDL</a>
+</p>
+
+
+
+ <div class="method-source-code"
+ id="validate--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 51</span>
+51: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate!</span>
+52: <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">validate_rpc_request</span>(<span class="ruby-ivar">@action</span>, <span class="ruby-ivar">@data</span>)
+53: <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>
+
--- /dev/null
+<?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::RPC::Result</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/rpc/result_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/result.rb">lib/mcollective/rpc/result.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="#M000428">::new</a></li>
+
+ <li><a href="#M000429">#[]</a></li>
+
+ <li><a href="#M000430">#[]=</a></li>
+
+ <li><a href="#M000432">#each</a></li>
+
+ <li><a href="#M000431">#fetch</a></li>
+
+ <li><a href="#M000433">#to_json</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ <div id="includes-section" class="section">
+ <h3 class="section-header">Included Modules</h3>
+ <ul class="link-list">
+
+
+ <li><span class="include">Enumerable</span></li>
+
+
+ </ul>
+ </div>
+
+ </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::RPC::Result</h1>
+
+ <div id="description">
+ <p>
+Simple class to manage compliant results from <a
+href="../RPC.html">MCollective::RPC</a> agents
+</p>
+<p>
+Currently it just fakes Hash behaviour to the result to remain backward
+compatible but it also knows which agent and action produced it so you can
+associate results to a <a href="../DDL.html">DDL</a>
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="agent-attribute-method" class="method-detail">
+ <a name="agent"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">agent</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="action-attribute-method" class="method-detail">
+ <a name="action"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">action</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="results-attribute-method" class="method-detail">
+ <a name="results"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">results</span><span
+ class="attribute-access-type">[R]</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="M000428"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(agent, action, result={})</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/rpc/result.rb, line 13</span>
+13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">result</span>={})
+14: <span class="ruby-ivar">@agent</span> = <span class="ruby-identifier">agent</span>
+15: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
+16: <span class="ruby-ivar">@results</span> = <span class="ruby-identifier">result</span>
+17: <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="--method" class="method-detail ">
+ <a name="M000429"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(idx)</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="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 19</span>
+19: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">idx</span>)
+20: <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">idx</span>]
+21: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000430"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]=</span><span
+ class="method-args">(idx, item)</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="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 23</span>
+23: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">idx</span>, <span class="ruby-identifier">item</span>)
+24: <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">idx</span>] = <span class="ruby-identifier">item</span>
+25: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="each-method" class="method-detail ">
+ <a name="M000432"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">each</span><span
+ class="method-args">()</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="each-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 31</span>
+31: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span>
+32: <span class="ruby-ivar">@results</span>.<span class="ruby-identifier">each_pair</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span>) }
+33: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="fetch-method" class="method-detail ">
+ <a name="M000431"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">fetch</span><span
+ class="method-args">(key, default)</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="fetch-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 27</span>
+27: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
+28: <span class="ruby-ivar">@results</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
+29: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="to-json-method" class="method-detail ">
+ <a name="M000433"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">to_json</span><span
+ class="method-args">(*a)</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="to-json-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 35</span>
+35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_json</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">a</span>)
+36: {<span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@agent</span>,
+37: <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@action</span>,
+38: <span class="ruby-identifier">:sender</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">:sender</span>],
+39: <span class="ruby-identifier">:statuscode</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">:statuscode</span>],
+40: <span class="ruby-identifier">:statusmsg</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">:statusmsg</span>],
+41: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">:data</span>]}.<span class="ruby-identifier">to_json</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">a</span>)
+42: <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>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>Class: MCollective::RPC::Stats</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::Stats</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/stats_rb.html">
- lib/mcollective/rpc/stats.rb
- </a>
- <br />
- </td>
- </tr>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
+ <title>Class: MCollective::RPC::Stats</title>
- <div id="bodyContent">
+ <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>
-
- <div id="contextContent">
-
- <div id="description">
- <p>
+</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/rpc/stats_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/rpc/stats.rb">lib/mcollective/rpc/stats.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="#M000420">::new</a></li>
+
+ <li><a href="#M000423">#[]</a></li>
+
+ <li><a href="#M000426">#client_stats=</a></li>
+
+ <li><a href="#M000435">#discovered_agents</a></li>
+
+ <li><a href="#M000425">#fail</a></li>
+
+ <li><a href="#M000436">#finish_request</a></li>
+
+ <li><a href="#M000440">#no_response_report</a></li>
+
+ <li><a href="#M000437">#node_responded</a></li>
+
+ <li><a href="#M000424">#ok</a></li>
+
+ <li><a href="#M000439">#report</a></li>
+
+ <li><a href="#M000421">#reset</a></li>
+
+ <li><a href="#M000438">#text_for_aggregates</a></li>
+
+ <li><a href="#M000434">#time_block_execution</a></li>
+
+ <li><a href="#M000427">#time_discovery</a></li>
+
+ <li><a href="#M000422">#to_hash</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::RPC::Stats</h1>
+
+ <div id="description">
+ <p>
Class to wrap all the stats and to keep track of some timings
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000123">[]</a>
- <a href="#M000126">client_stats=</a>
- <a href="#M000129">discovered_agents</a>
- <a href="#M000125">fail</a>
- <a href="#M000130">finish_request</a>
- <a href="#M000120">new</a>
- <a href="#M000134">no_response_report</a>
- <a href="#M000131">node_responded</a>
- <a href="#M000124">ok</a>
- <a href="#M000133">report</a>
- <a href="#M000121">reset</a>
- <a href="#M000132">text_for_aggregates</a>
- <a href="#M000128">time_block_execution</a>
- <a href="#M000127">time_discovery</a>
- <a href="#M000122">to_hash</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">aggregate_failures</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">aggregate_summary</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">blocktime</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ddl</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">discovered</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">discovered_nodes</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">discoverytime</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">failcount</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">noresponsefrom</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">noresponsefrom</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">okcount</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">requestid</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">responses</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">responsesfrom</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">starttime</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">totaltime</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000120" class="method-detail">
- <a name="M000120"></a>
-
- <div class="method-heading">
- <a href="#M000120" class="method-signature">
- <span class="method-name">new</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000120-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000120-source">
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="noresponsefrom-attribute-method" class="method-detail">
+ <a name="noresponsefrom"></a>
+
+ <a name="noresponsefrom="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">noresponsefrom</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="starttime-attribute-method" class="method-detail">
+ <a name="starttime"></a>
+
+ <a name="starttime="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">starttime</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="discoverytime-attribute-method" class="method-detail">
+ <a name="discoverytime"></a>
+
+ <a name="discoverytime="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">discoverytime</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="blocktime-attribute-method" class="method-detail">
+ <a name="blocktime"></a>
+
+ <a name="blocktime="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">blocktime</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="responses-attribute-method" class="method-detail">
+ <a name="responses"></a>
+
+ <a name="responses="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">responses</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="totaltime-attribute-method" class="method-detail">
+ <a name="totaltime"></a>
+
+ <a name="totaltime="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">totaltime</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="discovered-attribute-method" class="method-detail">
+ <a name="discovered"></a>
+
+ <a name="discovered="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">discovered</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="discovered-nodes-attribute-method" class="method-detail">
+ <a name="discovered_nodes"></a>
+
+ <a name="discovered_nodes="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">discovered_nodes</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="okcount-attribute-method" class="method-detail">
+ <a name="okcount"></a>
+
+ <a name="okcount="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">okcount</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="failcount-attribute-method" class="method-detail">
+ <a name="failcount"></a>
+
+ <a name="failcount="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">failcount</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="noresponsefrom-attribute-method" class="method-detail">
+ <a name="noresponsefrom"></a>
+
+ <a name="noresponsefrom="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">noresponsefrom</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="responsesfrom-attribute-method" class="method-detail">
+ <a name="responsesfrom"></a>
+
+ <a name="responsesfrom="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">responsesfrom</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="requestid-attribute-method" class="method-detail">
+ <a name="requestid"></a>
+
+ <a name="requestid="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">requestid</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="aggregate-summary-attribute-method" class="method-detail">
+ <a name="aggregate_summary"></a>
+
+ <a name="aggregate_summary="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">aggregate_summary</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ddl-attribute-method" class="method-detail">
+ <a name="ddl"></a>
+
+ <a name="ddl="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ddl</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="aggregate-failures-attribute-method" class="method-detail">
+ <a name="aggregate_failures"></a>
+
+ <a name="aggregate_failures="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">aggregate_failures</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="M000420"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">()</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/rpc/stats.rb, line 9</span>
9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
10: <span class="ruby-identifier">reset</span>
-11: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000123" class="method-detail">
- <a name="M000123"></a>
-
- <div class="method-heading">
- <a href="#M000123" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(key)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+11: <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="--method" class="method-detail ">
+ <a name="M000423"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(key)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Fake hash access to keep things backward compatible
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000123-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000123-source">
+
+
+
+ <div class="method-source-code"
+ id="--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 51</span>
51: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
52: <span class="ruby-identifier">to_hash</span>[<span class="ruby-identifier">key</span>]
53: <span class="ruby-keyword kw">rescue</span>
54: <span class="ruby-keyword kw">nil</span>
-55: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000126" class="method-detail">
- <a name="M000126"></a>
-
- <div class="method-heading">
- <a href="#M000126" class="method-signature">
- <span class="method-name">client_stats=</span><span class="method-args">(stats)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+55: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="client-stats--method" class="method-detail ">
+ <a name="M000426"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">client_stats=</span><span
+ class="method-args">(stats)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Re-initializes the object with stats from the basic client
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000126-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000126-source">
+
+
+
+ <div class="method-source-code"
+ id="client-stats--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 72</span>
72: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">client_stats=</span>(<span class="ruby-identifier">stats</span>)
77: <span class="ruby-ivar">@totaltime</span> = <span class="ruby-identifier">stats</span>[<span class="ruby-identifier">:totaltime</span>]
78: <span class="ruby-ivar">@requestid</span> = <span class="ruby-identifier">stats</span>[<span class="ruby-identifier">:requestid</span>]
79: <span class="ruby-ivar">@discoverytime</span> = <span class="ruby-identifier">stats</span>[<span class="ruby-identifier">:discoverytime</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@discoverytime</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
-80: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000129" class="method-detail">
- <a name="M000129"></a>
-
- <div class="method-heading">
- <a href="#M000129" class="method-signature">
- <span class="method-name">discovered_agents</span><span class="method-args">(agents)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Update discovered and discovered_nodes based on discovery results
+80: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="discovered-agents-method" class="method-detail ">
+ <a name="M000435"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">discovered_agents</span><span
+ class="method-args">(agents)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Update discovered and <a
+href="Stats.html#discovered_nodes">discovered_nodes</a> based on discovery
+results
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000129-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000129-source">
+
+
+
+ <div class="method-source-code"
+ id="discovered-agents-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 110</span>
110: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovered_agents</span>(<span class="ruby-identifier">agents</span>)
111: <span class="ruby-ivar">@discovered_nodes</span> = <span class="ruby-identifier">agents</span>
112: <span class="ruby-ivar">@discovered</span> = <span class="ruby-identifier">agents</span>.<span class="ruby-identifier">size</span>
-113: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000125" class="method-detail">
- <a name="M000125"></a>
-
- <div class="method-heading">
- <a href="#M000125" class="method-signature">
- <span class="method-name">fail</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+113: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="fail-method" class="method-detail ">
+ <a name="M000425"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">fail</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
increment the count of failed hosts
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000125-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000125-source">
+
+
+
+ <div class="method-source-code"
+ id="fail-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 65</span>
65: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fail</span>
66: <span class="ruby-ivar">@failcount</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
67: <span class="ruby-keyword kw">rescue</span>
68: <span class="ruby-ivar">@failcount</span> = <span class="ruby-value">1</span>
-69: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000130" class="method-detail">
- <a name="M000130"></a>
-
- <div class="method-heading">
- <a href="#M000130" class="method-signature">
- <span class="method-name">finish_request</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+69: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="finish-request-method" class="method-detail ">
+ <a name="M000436"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">finish_request</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Helper to calculate total time etc
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000130-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000130-source">
+
+
+
+ <div class="method-source-code"
+ id="finish-request-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 116</span>
116: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">finish_request</span>
123: <span class="ruby-keyword kw">rescue</span>
124: <span class="ruby-ivar">@totaltime</span> = <span class="ruby-value">0</span>
125: <span class="ruby-ivar">@noresponsefrom</span> = []
-126: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000134" class="method-detail">
- <a name="M000134"></a>
-
- <div class="method-heading">
- <a href="#M000134" class="method-signature">
- <span class="method-name">no_response_report</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+126: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="no-response-report-method" class="method-detail ">
+ <a name="M000440"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">no_response_report</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns a blob of text indicating what nodes did not respond
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000134-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000134-source">
+
+
+
+ <div class="method-source-code"
+ id="no-response-report-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 237</span>
237: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">no_response_report</span>
250: <span class="ruby-keyword kw">end</span>
251:
252: <span class="ruby-identifier">result_text</span>.<span class="ruby-identifier">string</span>
-253: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000131" class="method-detail">
- <a name="M000131"></a>
-
- <div class="method-heading">
- <a href="#M000131" class="method-signature">
- <span class="method-name">node_responded</span><span class="method-args">(node)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+253: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="node-responded-method" class="method-detail ">
+ <a name="M000437"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">node_responded</span><span
+ class="method-args">(node)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Helper to keep track of who we received responses from
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000131-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000131-source">
+
+
+
+ <div class="method-source-code"
+ id="node-responded-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 129</span>
129: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">node_responded</span>(<span class="ruby-identifier">node</span>)
130: <span class="ruby-ivar">@responsesfrom</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">node</span>
131: <span class="ruby-keyword kw">rescue</span>
132: <span class="ruby-ivar">@responsesfrom</span> = [<span class="ruby-identifier">node</span>]
-133: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000124" class="method-detail">
- <a name="M000124"></a>
-
- <div class="method-heading">
- <a href="#M000124" class="method-signature">
- <span class="method-name">ok</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-increment the count of <a href="Stats.html#M000124">ok</a> hosts
+133: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="ok-method" class="method-detail ">
+ <a name="M000424"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">ok</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+increment the count of ok hosts
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000124-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000124-source">
+
+
+
+ <div class="method-source-code"
+ id="ok-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 58</span>
58: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ok</span>
59: <span class="ruby-ivar">@okcount</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
60: <span class="ruby-keyword kw">rescue</span>
61: <span class="ruby-ivar">@okcount</span> = <span class="ruby-value">1</span>
-62: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000133" class="method-detail">
- <a name="M000133"></a>
-
- <div class="method-heading">
- <a href="#M000133" class="method-signature">
- <span class="method-name">report</span><span class="method-args">(caption = "rpc stats", summarize = true, verbose = false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+62: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="report-method" class="method-detail ">
+ <a name="M000439"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">report</span><span
+ class="method-args">(caption = "rpc stats", summarize = true, verbose = false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns a blob of text representing the request status based on the stats
contained in this class
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000133-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000133-source">
+
+
+
+ <div class="method-source-code"
+ id="report-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 187</span>
187: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">report</span>(<span class="ruby-identifier">caption</span> = <span class="ruby-value str">"rpc stats"</span>, <span class="ruby-identifier">summarize</span> = <span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">verbose</span> = <span class="ruby-keyword kw">false</span>)
231: <span class="ruby-keyword kw">end</span>
232:
233: <span class="ruby-identifier">result_text</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n"</span>)
-234: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000121" class="method-detail">
- <a name="M000121"></a>
-
- <div class="method-heading">
- <a href="#M000121" class="method-signature">
- <span class="method-name">reset</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+234: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="reset-method" class="method-detail ">
+ <a name="M000421"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">reset</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Resets stats, if discovery time is set we keep it as it was
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000121-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000121-source">
+
+
+
+ <div class="method-source-code"
+ id="reset-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 14</span>
14: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset</span>
27: <span class="ruby-ivar">@requestid</span> = <span class="ruby-keyword kw">nil</span>
28: <span class="ruby-ivar">@aggregate_summary</span> = []
29: <span class="ruby-ivar">@aggregate_failures</span> = []
-30: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000132" class="method-detail">
- <a name="M000132"></a>
-
- <div class="method-heading">
- <a href="#M000132" class="method-signature">
- <span class="method-name">text_for_aggregates</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000132-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000132-source">
+30: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="text-for-aggregates-method" class="method-detail ">
+ <a name="M000438"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">text_for_aggregates</span><span
+ class="method-args">()</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="text-for-aggregates-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 135</span>
135: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">text_for_aggregates</span>
180: <span class="ruby-keyword kw">end</span>
181:
182: <span class="ruby-identifier">result</span>.<span class="ruby-identifier">string</span>
-183: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000128" class="method-detail">
- <a name="M000128"></a>
-
- <div class="method-heading">
- <a href="#M000128" class="method-signature">
- <span class="method-name">time_block_execution</span><span class="method-args">(action)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+183: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="time-block-execution-method" class="method-detail ">
+ <a name="M000434"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">time_block_execution</span><span
+ class="method-args">(action)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
helper to time block execution time
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000128-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000128-source">
+
+
+
+ <div class="method-source-code"
+ id="time-block-execution-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 96</span>
96: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">time_block_execution</span>(<span class="ruby-identifier">action</span>)
103: <span class="ruby-keyword kw">end</span>
104: <span class="ruby-keyword kw">rescue</span>
105: <span class="ruby-ivar">@blocktime</span> = <span class="ruby-value">0</span>
-106: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000127" class="method-detail">
- <a name="M000127"></a>
-
- <div class="method-heading">
- <a href="#M000127" class="method-signature">
- <span class="method-name">time_discovery</span><span class="method-args">(action)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+106: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="time-discovery-method" class="method-detail ">
+ <a name="M000427"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">time_discovery</span><span
+ class="method-args">(action)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Utility to time discovery from :start to :end
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000127-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000127-source">
+
+
+
+ <div class="method-source-code"
+ id="time-discovery-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 83</span>
83: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">time_discovery</span>(<span class="ruby-identifier">action</span>)
90: <span class="ruby-keyword kw">end</span>
91: <span class="ruby-keyword kw">rescue</span>
92: <span class="ruby-ivar">@discoverytime</span> = <span class="ruby-value">0</span>
-93: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000122" class="method-detail">
- <a name="M000122"></a>
-
- <div class="method-heading">
- <a href="#M000122" class="method-signature">
- <span class="method-name">to_hash</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+93: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="to-hash-method" class="method-detail ">
+ <a name="M000422"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">to_hash</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
returns a hash of our stats
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000122-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000122-source">
+
+
+
+ <div class="method-source-code"
+ id="to-hash-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/rpc/stats.rb, line 33</span>
33: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
45: <span class="ruby-identifier">:failcount</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@failcount</span>,
46: <span class="ruby-identifier">:aggregate_summary</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@aggregate_summary</span>,
47: <span class="ruby-identifier">:aggregate_failures</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@aggregate_failures</span>}
-48: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+48: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </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>
-</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>
\ No newline at end of file
+</html>
+
--- /dev/null
+<?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::RPCAborted</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">RPCError</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::RPCAborted</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::RPCError</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">StandardError</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::RPCError</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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>Module: MCollective::Registration</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="module">
+
+ <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/registration/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/registration/base.rb">lib/mcollective/registration/base.rb</a></li>
+
+ <li><a href="../lib/mcollective/registration_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/registration.rb">lib/mcollective/registration.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="Registration/Base.html">MCollective::Registration::Base</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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="module">MCollective::Registration</h1>
+
+ <div id="description">
+ <p>
+<a href="Registration.html">Registration</a> is implimented using a module
+structure and installations can configure which module they want to use.
+</p>
+<p>
+We provide a simple one that just sends back the list of current known
+agents in MCollective::Registration::Agentlist, you can create your own:
+</p>
+<p>
+Create a module in plugins/mcollective/registration/<yourplugin>.rb
+</p>
+<p>
+You can inherit from <a
+href="Registration/Base.html">MCollective::Registration::Base</a> in which
+case you just need to supply a <em>body</em> method, whatever this method
+returns will be send to the middleware connection for an agent called
+<em>registration</em>
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::Registration::Base</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/registration/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/registration/base.rb">lib/mcollective/registration/base.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="#M000151">::inherited</a></li>
+
+ <li><a href="#M000153">#config</a></li>
+
+ <li><a href="#M000158">#interval</a></li>
+
+ <li><a href="#M000154">#msg_filter</a></li>
+
+ <li><a href="#M000159">#publish</a></li>
+
+ <li><a href="#M000152">#run</a></li>
+
+ <li><a href="#M000157">#target_collective</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::Registration::Base</h1>
+
+ <div id="description">
+ <p>
+This is a base class that other registration plugins can use to handle
+regular announcements to the mcollective
+</p>
+<p>
+The configuration file determines how often registration messages gets sent
+using the <em>registerinterval</em> option, the plugin runs in the
+background in a thread.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="inherited-method" class="method-detail ">
+ <a name="M000151"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">inherited</span><span
+ class="method-args">(klass)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Register plugins that inherits base
+</p>
+
+
+
+ <div class="method-source-code"
+ id="inherited-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 11</span>
+11: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
+12: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"registration_plugin"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>}
+13: <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="config-method" class="method-detail ">
+ <a name="M000153"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">config</span><span
+ class="method-args">()</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="config-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 36</span>
+36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">config</span>
+37: <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
+38: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="interval-method" class="method-detail ">
+ <a name="M000158"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">interval</span><span
+ class="method-args">()</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="interval-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 59</span>
+59: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">interval</span>
+60: <span class="ruby-identifier">config</span>.<span class="ruby-identifier">registerinterval</span>
+61: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="msg-filter-method" class="method-detail ">
+ <a name="M000154"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">msg_filter</span><span
+ class="method-args">()</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="msg-filter-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 40</span>
+40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">msg_filter</span>
+41: <span class="ruby-identifier">filter</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter</span>
+42: <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"agent"</span>] <span class="ruby-operator"><<</span> <span class="ruby-value str">"registration"</span>
+43: <span class="ruby-identifier">filter</span>
+44: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="publish-method" class="method-detail ">
+ <a name="M000159"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">publish</span><span
+ class="method-args">(message)</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="publish-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 63</span>
+63: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">publish</span>(<span class="ruby-identifier">message</span>)
+64: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">message</span>
+65: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Skipping registration due to nil body"</span>)
+66: <span class="ruby-keyword kw">else</span>
+67: <span class="ruby-identifier">req</span> = <span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">message</span>, <span class="ruby-keyword kw">nil</span>, {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:request</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"registration"</span>, <span class="ruby-identifier">:collective</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">target_collective</span>, <span class="ruby-identifier">:filter</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">msg_filter</span>})
+68: <span class="ruby-identifier">req</span>.<span class="ruby-identifier">encode!</span>
+69:
+70: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Sending registration #{req.requestid} to collective #{req.collective}"</span>)
+71:
+72: <span class="ruby-identifier">req</span>.<span class="ruby-identifier">publish</span>
+73: <span class="ruby-keyword kw">end</span>
+74: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="run-method" class="method-detail ">
+ <a name="M000152"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">run</span><span
+ class="method-args">(connection)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates a background thread that periodically send a registration notice.
+</p>
+<p>
+The actual registration notices comes from the ‘body’ method of
+the registration plugins.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="run-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 19</span>
+19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>(<span class="ruby-identifier">connection</span>)
+20: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">interval</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+21:
+22: <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span>
+23: <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
+24: <span class="ruby-keyword kw">begin</span>
+25: <span class="ruby-identifier">publish</span>(<span class="ruby-identifier">body</span>)
+26:
+27: <span class="ruby-identifier">sleep</span> <span class="ruby-identifier">interval</span>
+28: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+29: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Sending registration message failed: #{e}"</span>)
+30: <span class="ruby-identifier">sleep</span> <span class="ruby-identifier">interval</span>
+31: <span class="ruby-keyword kw">end</span>
+32: <span class="ruby-keyword kw">end</span>
+33: <span class="ruby-keyword kw">end</span>
+34: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="target-collective-method" class="method-detail ">
+ <a name="M000157"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">target_collective</span><span
+ class="method-args">()</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="target-collective-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 46</span>
+46: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">target_collective</span>
+47: <span class="ruby-identifier">main_collective</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">main_collective</span>
+48:
+49: <span class="ruby-identifier">collective</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">registration_collective</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">main_collective</span>
+50:
+51: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">collectives</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">collective</span>)
+52: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Sending registration to #{main_collective}: #{collective} is not a valid collective"</span>)
+53: <span class="ruby-identifier">collective</span> = <span class="ruby-identifier">main_collective</span>
+54: <span class="ruby-keyword kw">end</span>
+55:
+56: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">collective</span>
+57: <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>
+
--- /dev/null
+<?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::Runner</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/runner_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/runner.rb">lib/mcollective/runner.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="#M000069">::new</a></li>
+
+ <li><a href="#M000071">#agentmsg</a></li>
+
+ <li><a href="#M000072">#controlmsg</a></li>
+
+ <li><a href="#M000077">#receive</a></li>
+
+ <li><a href="#M000078">#reply</a></li>
+
+ <li><a href="#M000070">#run</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ <div id="includes-section" class="section">
+ <h3 class="section-header">Included Modules</h3>
+ <ul class="link-list">
+
+
+ <li><a class="include" href="Validator.html">MCollective::Validator</a></li>
+
+
+ </ul>
+ </div>
+
+ </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::Runner</h1>
+
+ <div id="description">
+ <p>
+The main runner for the daemon, supports running in the foreground and the
+background, keeps detailed stats and provides hooks to access all this
+information
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- 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="M000069"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(configfile)</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/runner.rb, line 8</span>
+ 8: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">configfile</span>)
+ 9: <span class="ruby-ivar">@config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
+10: <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">loadconfig</span>(<span class="ruby-identifier">configfile</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">configured</span>
+11: <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">mode</span> = <span class="ruby-identifier">:server</span>
+12:
+13: <span class="ruby-ivar">@stats</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"global_stats"</span>]
+14:
+15: <span class="ruby-ivar">@security</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>]
+16: <span class="ruby-ivar">@security</span>.<span class="ruby-identifier">initiated_by</span> = <span class="ruby-identifier">:node</span>
+17:
+18: <span class="ruby-ivar">@connection</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"connector_plugin"</span>]
+19: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">connect</span>
+20:
+21: <span class="ruby-ivar">@agents</span> = <span class="ruby-constant">Agents</span>.<span class="ruby-identifier">new</span>
+22:
+23: <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
+24: <span class="ruby-constant">Signal</span>.<span class="ruby-identifier">trap</span>(<span class="ruby-value str">"USR1"</span>) <span class="ruby-keyword kw">do</span>
+25: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC2</span>, <span class="ruby-value str">"Reloading all agents after receiving USR1 signal"</span>, <span class="ruby-identifier">:info</span>)
+26: <span class="ruby-ivar">@agents</span>.<span class="ruby-identifier">loadagents</span>
+27: <span class="ruby-keyword kw">end</span>
+28:
+29: <span class="ruby-constant">Signal</span>.<span class="ruby-identifier">trap</span>(<span class="ruby-value str">"USR2"</span>) <span class="ruby-keyword kw">do</span>
+30: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC3</span>, <span class="ruby-value str">"Cycling logging level due to USR2 signal"</span>, <span class="ruby-identifier">:info</span>)
+31:
+32: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">cycle_level</span>
+33: <span class="ruby-keyword kw">end</span>
+34: <span class="ruby-keyword kw">else</span>
+35: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">setup_windows_sleeper</span>
+36: <span class="ruby-keyword kw">end</span>
+37: <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="run-method" class="method-detail ">
+ <a name="M000070"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">run</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Starts the main loop, before calling this you should initialize the <a
+href="Config.html">MCollective::Config</a> singleton.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="run-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runner.rb, line 40</span>
+40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>
+41: <span class="ruby-constant">Data</span>.<span class="ruby-identifier">load_data_sources</span>
+42:
+43: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-constant">Util</span>.<span class="ruby-identifier">make_subscriptions</span>(<span class="ruby-value str">"mcollective"</span>, <span class="ruby-identifier">:broadcast</span>))
+44: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-constant">Util</span>.<span class="ruby-identifier">make_subscriptions</span>(<span class="ruby-value str">"mcollective"</span>, <span class="ruby-identifier">:directed</span>)) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">direct_addressing</span>
+45:
+46: <span class="ruby-comment cmt"># Start the registration plugin if interval isn't 0</span>
+47: <span class="ruby-keyword kw">begin</span>
+48: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"registration_plugin"</span>].<span class="ruby-identifier">run</span>(<span class="ruby-ivar">@connection</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">registerinterval</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+49: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+50: <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">:PLMC4</span>, <span class="ruby-value str">"Failed to start registration plugin: %{error}"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">e</span>)
+51: <span class="ruby-keyword kw">end</span>
+52:
+53: <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
+54: <span class="ruby-keyword kw">begin</span>
+55: <span class="ruby-identifier">request</span> = <span class="ruby-identifier">receive</span>
+56:
+57: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">request</span>.<span class="ruby-identifier">agent</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"mcollective"</span>
+58: <span class="ruby-identifier">agentmsg</span>(<span class="ruby-identifier">request</span>)
+59: <span class="ruby-keyword kw">else</span>
+60: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC5</span>, <span class="ruby-value str">"Received a control message, possibly via 'mco controller' but this has been deprecated"</span>, <span class="ruby-identifier">:error</span>)
+61: <span class="ruby-keyword kw">end</span>
+62: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">SignalException</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+63: <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">:PLMC7</span>, <span class="ruby-value str">"Exiting after signal: %{error}"</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">e</span>)
+64: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">disconnect</span>
+65: <span class="ruby-identifier">raise</span>
+66:
+67: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">MsgTTLExpired</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+68: <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">:PLMC9</span>, <span class="ruby-value str">"Expired Message: %{error}"</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">e</span>)
+69:
+70: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NotTargettedAtUs</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+71: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC6</span>, <span class="ruby-value str">"Message does not pass filters, ignoring"</span>, <span class="ruby-identifier">:debug</span>)
+72:
+73: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+74: <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">:PLMC10</span>, <span class="ruby-value str">"Failed to handle message: %{error}"</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">e</span>, <span class="ruby-keyword kw">true</span>)
+75: <span class="ruby-keyword kw">end</span>
+76: <span class="ruby-keyword kw">end</span>
+77: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+ <div id="private-instance-method-details" class="method-section section">
+ <h3 class="section-header">Private Instance Methods</h3>
+
+
+ <div id="agentmsg-method" class="method-detail ">
+ <a name="M000071"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">agentmsg</span><span
+ class="method-args">(request)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Deals with messages directed to agents
+</p>
+
+
+
+ <div class="method-source-code"
+ id="agentmsg-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runner.rb, line 81</span>
+81: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">agentmsg</span>(<span class="ruby-identifier">request</span>)
+82: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC8</span>, <span class="ruby-value str">"Handling message for agent '%{agent}' on collective '%{collective} with requestid '%{requestid}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">request</span>.<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:collective</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">request</span>.<span class="ruby-identifier">collective</span>, <span class="ruby-identifier">:requestid</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">request</span>.<span class="ruby-identifier">requestid</span>)
+83:
+84: <span class="ruby-ivar">@agents</span>.<span class="ruby-identifier">dispatch</span>(<span class="ruby-identifier">request</span>, <span class="ruby-ivar">@connection</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">reply_message</span><span class="ruby-operator">|</span>
+85: <span class="ruby-identifier">reply</span>(<span class="ruby-identifier">reply_message</span>, <span class="ruby-identifier">request</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">reply_message</span>
+86: <span class="ruby-keyword kw">end</span>
+87: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="controlmsg-method" class="method-detail ">
+ <a name="M000072"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">controlmsg</span><span
+ class="method-args">(request)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Deals with messages sent to our control topic
+</p>
+
+
+
+ <div class="method-source-code"
+ id="controlmsg-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runner.rb, line 90</span>
+ 90: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">controlmsg</span>(<span class="ruby-identifier">request</span>)
+ 91: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Handling message for mcollectived controller"</span>)
+ 92:
+ 93: <span class="ruby-keyword kw">begin</span>
+ 94: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">request</span>.<span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:body</span>]
+ 95: <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/^stats$/</span>
+ 96: <span class="ruby-identifier">reply</span>(<span class="ruby-ivar">@stats</span>.<span class="ruby-identifier">to_hash</span>, <span class="ruby-identifier">request</span>)
+ 97:
+ 98: <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/^reload_agent (.+)$/</span>
+ 99: <span class="ruby-identifier">reply</span>(<span class="ruby-node">"reloaded #{$1} agent"</span>, <span class="ruby-identifier">request</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@agents</span>.<span class="ruby-identifier">loadagent</span>(<span class="ruby-identifier">$1</span>)
+100:
+101: <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/^reload_agents$/</span>
+102:
+103: <span class="ruby-identifier">reply</span>(<span class="ruby-value str">"reloaded all agents"</span>, <span class="ruby-identifier">request</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@agents</span>.<span class="ruby-identifier">loadagents</span>
+104:
+105: <span class="ruby-keyword kw">else</span>
+106: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-value str">"Received an unknown message to the controller"</span>)
+107:
+108: <span class="ruby-keyword kw">end</span>
+109: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+110: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Failed to handle control message: #{e}"</span>)
+111: <span class="ruby-keyword kw">end</span>
+112: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="receive-method" class="method-detail ">
+ <a name="M000077"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">receive</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Receive a message from the connection handler
+</p>
+
+
+
+ <div class="method-source-code"
+ id="receive-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runner.rb, line 115</span>
+115: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">receive</span>
+116: <span class="ruby-identifier">request</span> = <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">receive</span>
+117: <span class="ruby-identifier">request</span>.<span class="ruby-identifier">type</span> = <span class="ruby-identifier">:request</span>
+118:
+119: <span class="ruby-ivar">@stats</span>.<span class="ruby-identifier">received</span>
+120:
+121: <span class="ruby-identifier">request</span>.<span class="ruby-identifier">decode!</span>
+122: <span class="ruby-identifier">request</span>.<span class="ruby-identifier">validate</span>
+123:
+124: <span class="ruby-identifier">request</span>
+125: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="reply-method" class="method-detail ">
+ <a name="M000078"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">reply</span><span
+ class="method-args">(msg, request)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Sends a reply to a specific target topic
+</p>
+
+
+
+ <div class="method-source-code"
+ id="reply-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runner.rb, line 128</span>
+128: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reply</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">request</span>)
+129: <span class="ruby-identifier">msg</span> = <span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">:request</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">request</span>)
+130: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">encode!</span>
+131: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">publish</span>
+132:
+133: <span class="ruby-ivar">@stats</span>.<span class="ruby-identifier">sent</span>
+134: <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>
+
--- /dev/null
+<?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::RunnerStats</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/runnerstats_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/runnerstats.rb">lib/mcollective/runnerstats.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="#M000225">::new</a></li>
+
+ <li><a href="#M000228">#filtered</a></li>
+
+ <li><a href="#M000227">#passed</a></li>
+
+ <li><a href="#M000231">#received</a></li>
+
+ <li><a href="#M000232">#sent</a></li>
+
+ <li><a href="#M000233">#to_hash</a></li>
+
+ <li><a href="#M000226">#ttlexpired</a></li>
+
+ <li><a href="#M000230">#unvalidated</a></li>
+
+ <li><a href="#M000229">#validated</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::RunnerStats</h1>
+
+ <div id="description">
+ <p>
+Class to store stats about the mcollectived, it should live in the <a
+href="PluginManager.html">PluginManager</a> so that agents etc can get hold
+of it and return the stats to callers
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- 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="M000225"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">()</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/runnerstats.rb, line 5</span>
+ 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+ 6: <span class="ruby-ivar">@starttime</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>
+ 7: <span class="ruby-ivar">@validated</span> = <span class="ruby-value">0</span>
+ 8: <span class="ruby-ivar">@unvalidated</span> = <span class="ruby-value">0</span>
+ 9: <span class="ruby-ivar">@filtered</span> = <span class="ruby-value">0</span>
+10: <span class="ruby-ivar">@passed</span> = <span class="ruby-value">0</span>
+11: <span class="ruby-ivar">@total</span> = <span class="ruby-value">0</span>
+12: <span class="ruby-ivar">@replies</span> = <span class="ruby-value">0</span>
+13: <span class="ruby-ivar">@ttlexpired</span> = <span class="ruby-value">0</span>
+14:
+15: <span class="ruby-ivar">@mutex</span> = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
+16: <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="filtered-method" class="method-detail ">
+ <a name="M000228"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">filtered</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Records a message that didnt pass the filters
+</p>
+
+
+
+ <div class="method-source-code"
+ id="filtered-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 31</span>
+31: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">filtered</span>
+32: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing filtered stat"</span>)
+33: <span class="ruby-ivar">@filtered</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+34: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="passed-method" class="method-detail ">
+ <a name="M000227"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">passed</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Records a message that passed the filters
+</p>
+
+
+
+ <div class="method-source-code"
+ id="passed-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 25</span>
+25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">passed</span>
+26: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing passed stat"</span>)
+27: <span class="ruby-ivar">@passed</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+28: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="received-method" class="method-detail ">
+ <a name="M000231"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">received</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Records receipt of a message
+</p>
+
+
+
+ <div class="method-source-code"
+ id="received-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 48</span>
+48: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">received</span>
+49: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing total stat"</span>)
+50: <span class="ruby-ivar">@total</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+51: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="sent-method" class="method-detail ">
+ <a name="M000232"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">sent</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Records sending a message
+</p>
+
+
+
+ <div class="method-source-code"
+ id="sent-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 54</span>
+54: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sent</span>
+55: <span class="ruby-ivar">@mutex</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+56: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing replies stat"</span>)
+57: <span class="ruby-ivar">@replies</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+58: <span class="ruby-keyword kw">end</span>
+59: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="to-hash-method" class="method-detail ">
+ <a name="M000233"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">to_hash</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns a hash with all stats
+</p>
+
+
+
+ <div class="method-source-code"
+ id="to-hash-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 62</span>
+62: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
+63: <span class="ruby-identifier">stats</span> = {<span class="ruby-identifier">:validated</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@validated</span>,
+64: <span class="ruby-identifier">:unvalidated</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@unvalidated</span>,
+65: <span class="ruby-identifier">:passed</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@passed</span>,
+66: <span class="ruby-identifier">:filtered</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@filtered</span>,
+67: <span class="ruby-identifier">:starttime</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@starttime</span>,
+68: <span class="ruby-identifier">:total</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@total</span>,
+69: <span class="ruby-identifier">:ttlexpired</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@ttlexpired</span>,
+70: <span class="ruby-identifier">:replies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@replies</span>}
+71:
+72: <span class="ruby-identifier">reply</span> = {<span class="ruby-identifier">:stats</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">stats</span>,
+73: <span class="ruby-identifier">:threads</span> =<span class="ruby-operator">></span> [],
+74: <span class="ruby-identifier">:pid</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Process</span>.<span class="ruby-identifier">pid</span>,
+75: <span class="ruby-identifier">:times</span> =<span class="ruby-operator">></span> {} }
+76:
+77: <span class="ruby-operator">::</span><span class="ruby-constant">Process</span>.<span class="ruby-identifier">times</span>.<span class="ruby-identifier">each_pair</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
+78: <span class="ruby-identifier">k</span> = <span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_sym</span>
+79: <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:times</span>][<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">v</span>
+80: }
+81:
+82: <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">list</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span>
+83: <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:threads</span>] <span class="ruby-operator"><<</span> <span class="ruby-node">"#{t.inspect}"</span>
+84: <span class="ruby-keyword kw">end</span>
+85:
+86: <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:agents</span>] = <span class="ruby-constant">Agents</span>.<span class="ruby-identifier">agentlist</span>
+87: <span class="ruby-identifier">reply</span>
+88: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="ttlexpired-method" class="method-detail ">
+ <a name="M000226"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">ttlexpired</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Records a message that failed TTL checks
+</p>
+
+
+
+ <div class="method-source-code"
+ id="ttlexpired-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 19</span>
+19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ttlexpired</span>
+20: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing ttl expired stat"</span>)
+21: <span class="ruby-ivar">@ttlexpired</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+22: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="unvalidated-method" class="method-detail ">
+ <a name="M000230"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">unvalidated</span><span
+ class="method-args">()</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="unvalidated-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 42</span>
+42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unvalidated</span>
+43: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing unvalidated stat"</span>)
+44: <span class="ruby-ivar">@unvalidated</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+45: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validated-method" class="method-detail ">
+ <a name="M000229"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validated</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Records a message that validated ok
+</p>
+
+
+
+ <div class="method-source-code"
+ id="validated-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 37</span>
+37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validated</span>
+38: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing validated stat"</span>)
+39: <span class="ruby-ivar">@validated</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+40: <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>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>Class: MCollective::SSL</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::SSL</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/ssl_rb.html">
- lib/mcollective/ssl.rb
- </a>
- <br />
- </td>
- </tr>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
+ <title>Class: MCollective::SSL</title>
- <div id="bodyContent">
+ <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>
-
- <div id="contextContent">
-
- <div id="description">
- <p>
+</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/ssl_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/ssl.rb">lib/mcollective/ssl.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="#M000220">::base64_decode</a></li>
+
+ <li><a href="#M000218">::base64_encode</a></li>
+
+ <li><a href="#M000222">::md5</a></li>
+
+ <li><a href="#M000202">::new</a></li>
+
+ <li><a href="#M000223">::uuid</a></li>
+
+ <li><a href="#M000214">#aes_decrypt</a></li>
+
+ <li><a href="#M000213">#aes_encrypt</a></li>
+
+ <li><a href="#M000219">#base64_decode</a></li>
+
+ <li><a href="#M000217">#base64_encode</a></li>
+
+ <li><a href="#M000207">#decrypt_with_private</a></li>
+
+ <li><a href="#M000208">#decrypt_with_public</a></li>
+
+ <li><a href="#M000206">#encrypt_with_private</a></li>
+
+ <li><a href="#M000205">#encrypt_with_public</a></li>
+
+ <li><a href="#M000221">#md5</a></li>
+
+ <li><a href="#M000224">#read_key</a></li>
+
+ <li><a href="#M000210">#rsa_decrypt_with_private</a></li>
+
+ <li><a href="#M000212">#rsa_decrypt_with_public</a></li>
+
+ <li><a href="#M000211">#rsa_encrypt_with_private</a></li>
+
+ <li><a href="#M000209">#rsa_encrypt_with_public</a></li>
+
+ <li><a href="#M000215">#sign</a></li>
+
+ <li><a href="#M000216">#verify_signature</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::SSL</h1>
+
+ <div id="description">
+ <p>
A class that assists in encrypting and decrypting data using a combination
of RSA and AES
</p>
<p>
The key and data will all be base 64 encoded already by default you can
pass a 2nd parameter as false to <a
-href="SSL.html#M000378">encrypt_with_private</a> and counterparts that will
+href="SSL.html#M000206">encrypt_with_private</a> and counterparts that will
prevent the base 64 encoding
</p>
<p>
decrypted using a private key
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000386">aes_decrypt</a>
- <a href="#M000385">aes_encrypt</a>
- <a href="#M000392">base64_decode</a>
- <a href="#M000391">base64_decode</a>
- <a href="#M000390">base64_encode</a>
- <a href="#M000389">base64_encode</a>
- <a href="#M000379">decrypt_with_private</a>
- <a href="#M000380">decrypt_with_public</a>
- <a href="#M000378">encrypt_with_private</a>
- <a href="#M000377">encrypt_with_public</a>
- <a href="#M000394">md5</a>
- <a href="#M000393">md5</a>
- <a href="#M000376">new</a>
- <a href="#M000396">read_key</a>
- <a href="#M000382">rsa_decrypt_with_private</a>
- <a href="#M000384">rsa_decrypt_with_public</a>
- <a href="#M000383">rsa_encrypt_with_private</a>
- <a href="#M000381">rsa_encrypt_with_public</a>
- <a href="#M000387">sign</a>
- <a href="#M000395">uuid</a>
- <a href="#M000388">verify_signature</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">private_key_file</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">public_key_file</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ssl_cipher</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000392" class="method-detail">
- <a name="M000392"></a>
-
- <div class="method-heading">
- <a href="#M000392" class="method-signature">
- <span class="method-name">base64_decode</span><span class="method-args">(string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000392-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000392-source">
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="public-key-file-attribute-method" class="method-detail">
+ <a name="public_key_file"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">public_key_file</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="private-key-file-attribute-method" class="method-detail">
+ <a name="private_key_file"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">private_key_file</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="ssl-cipher-attribute-method" class="method-detail">
+ <a name="ssl_cipher"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">ssl_cipher</span><span
+ class="attribute-access-type">[R]</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="base-decode-method" class="method-detail ">
+ <a name="M000220"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">base64_decode</span><span
+ class="method-args">(string)</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="base-decode-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 195</span>
195: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">base64_decode</span>(<span class="ruby-identifier">string</span>)
196: <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">decode64</span>(<span class="ruby-identifier">string</span>)
-197: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000390" class="method-detail">
- <a name="M000390"></a>
-
- <div class="method-heading">
- <a href="#M000390" class="method-signature">
- <span class="method-name">base64_encode</span><span class="method-args">(string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000390-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000390-source">
+197: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="base-encode-method" class="method-detail ">
+ <a name="M000218"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">base64_encode</span><span
+ class="method-args">(string)</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="base-encode-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 186</span>
186: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">base64_encode</span>(<span class="ruby-identifier">string</span>)
187: <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">encode64</span>(<span class="ruby-identifier">string</span>)
-188: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000394" class="method-detail">
- <a name="M000394"></a>
-
- <div class="method-heading">
- <a href="#M000394" class="method-signature">
- <span class="method-name">md5</span><span class="method-args">(string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000394-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000394-source">
+188: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="md--method" class="method-detail ">
+ <a name="M000222"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">md5</span><span
+ class="method-args">(string)</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="md--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 203</span>
203: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">md5</span>(<span class="ruby-identifier">string</span>)
204: <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-identifier">string</span>)
-205: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000376" class="method-detail">
- <a name="M000376"></a>
-
- <div class="method-heading">
- <a href="#M000376" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(pubkey=nil, privkey=nil, passphrase=nil, cipher=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000376-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000376-source">
+205: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="new-method" class="method-detail ">
+ <a name="M000202"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(pubkey=nil, privkey=nil, passphrase=nil, cipher=nil)</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/ssl.rb, line 37</span>
37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">pubkey</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">privkey</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">passphrase</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">cipher</span>=<span class="ruby-keyword kw">nil</span>)
46: <span class="ruby-ivar">@ssl_cipher</span> = <span class="ruby-identifier">cipher</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">cipher</span>
47:
48: <span class="ruby-identifier">raise</span> <span class="ruby-node">"The supplied cipher '#{@ssl_cipher}' is not supported"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">ciphers</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@ssl_cipher</span>)
-49: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000395" class="method-detail">
- <a name="M000395"></a>
-
- <div class="method-heading">
- <a href="#M000395" class="method-signature">
- <span class="method-name">uuid</span><span class="method-args">(string=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+49: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="uuid-method" class="method-detail ">
+ <a name="M000223"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">uuid</span><span
+ class="method-args">(string=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Creates a RFC 4122 version 5 UUID. If string is supplied it will produce
repeatable UUIDs for that string else a random 128bit string will be used
from OpenSSL::BN
<pre>
https://github.com/kwilczynski/puppet-functions/blob/master/lib/puppet/parser/functions/uuid.rb
</pre>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000395-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000395-source">
+
+
+
+ <div class="method-source-code"
+ id="uuid-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 213</span>
213: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">uuid</span>(<span class="ruby-identifier">string</span>=<span class="ruby-keyword kw">nil</span>)
235: <span class="ruby-keyword kw">end</span>
236:
237: <span class="ruby-identifier">bytes</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">'-'</span>)
-238: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000386" class="method-detail">
- <a name="M000386"></a>
-
- <div class="method-heading">
- <a href="#M000386" class="method-signature">
- <span class="method-name">aes_decrypt</span><span class="method-args">(key, crypt_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+238: <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="aes-decrypt-method" class="method-detail ">
+ <a name="M000214"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">aes_decrypt</span><span
+ class="method-args">(key, crypt_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
decrypts a string given key, iv and data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000386-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000386-source">
+
+
+
+ <div class="method-source-code"
+ id="aes-decrypt-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 158</span>
158: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">aes_decrypt</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">crypt_string</span>)
162: <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">key</span> = <span class="ruby-identifier">key</span>
163: <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">pkcs5_keyivgen</span>(<span class="ruby-identifier">key</span>)
164: <span class="ruby-identifier">decrypted_data</span> = <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">crypt_string</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">final</span>
-165: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000385" class="method-detail">
- <a name="M000385"></a>
-
- <div class="method-heading">
- <a href="#M000385" class="method-signature">
- <span class="method-name">aes_encrypt</span><span class="method-args">(plain_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+165: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="aes-encrypt-method" class="method-detail ">
+ <a name="M000213"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">aes_encrypt</span><span
+ class="method-args">(plain_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
encrypts a string, returns a hash of key, iv and data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000385-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000385-source">
+
+
+
+ <div class="method-source-code"
+ id="aes-encrypt-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 144</span>
144: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">aes_encrypt</span>(<span class="ruby-identifier">plain_string</span>)
152: <span class="ruby-identifier">encrypted_data</span> = <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">plain_string</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">final</span>
153:
154: {<span class="ruby-identifier">:key</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">encrypted_data</span>}
-155: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000391" class="method-detail">
- <a name="M000391"></a>
-
- <div class="method-heading">
- <a href="#M000391" class="method-signature">
- <span class="method-name">base64_decode</span><span class="method-args">(string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+155: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="base-decode-method" class="method-detail ">
+ <a name="M000219"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">base64_decode</span><span
+ class="method-args">(string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
base 64 decode a string
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000391-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000391-source">
+
+
+
+ <div class="method-source-code"
+ id="base-decode-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 191</span>
191: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">base64_decode</span>(<span class="ruby-identifier">string</span>)
192: <span class="ruby-constant">SSL</span>.<span class="ruby-identifier">base64_decode</span>(<span class="ruby-identifier">string</span>)
-193: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000389" class="method-detail">
- <a name="M000389"></a>
-
- <div class="method-heading">
- <a href="#M000389" class="method-signature">
- <span class="method-name">base64_encode</span><span class="method-args">(string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+193: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="base-encode-method" class="method-detail ">
+ <a name="M000217"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">base64_encode</span><span
+ class="method-args">(string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
base 64 encode a string
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000389-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000389-source">
+
+
+
+ <div class="method-source-code"
+ id="base-encode-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 182</span>
182: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">base64_encode</span>(<span class="ruby-identifier">string</span>)
183: <span class="ruby-constant">SSL</span>.<span class="ruby-identifier">base64_encode</span>(<span class="ruby-identifier">string</span>)
-184: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000379" class="method-detail">
- <a name="M000379"></a>
-
- <div class="method-heading">
- <a href="#M000379" class="method-signature">
- <span class="method-name">decrypt_with_private</span><span class="method-args">(crypted, base64=true)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+184: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="decrypt-with-private-method" class="method-detail ">
+ <a name="M000207"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">decrypt_with_private</span><span
+ class="method-args">(crypted, base64=true)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Decrypts data, expects a hash as create with crypt_with_public
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000379-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000379-source">
+
+
+
+ <div class="method-source-code"
+ id="decrypt-with-private-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 88</span>
88: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">decrypt_with_private</span>(<span class="ruby-identifier">crypted</span>, <span class="ruby-identifier">base64</span>=<span class="ruby-keyword kw">true</span>)
96: <span class="ruby-identifier">key</span> = <span class="ruby-identifier">rsa_decrypt_with_private</span>(<span class="ruby-identifier">crypted</span>[<span class="ruby-identifier">:key</span>])
97: <span class="ruby-identifier">aes_decrypt</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">crypted</span>[<span class="ruby-identifier">:data</span>])
98: <span class="ruby-keyword kw">end</span>
-99: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000380" class="method-detail">
- <a name="M000380"></a>
-
- <div class="method-heading">
- <a href="#M000380" class="method-signature">
- <span class="method-name">decrypt_with_public</span><span class="method-args">(crypted, base64=true)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+99: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="decrypt-with-public-method" class="method-detail ">
+ <a name="M000208"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">decrypt_with_public</span><span
+ class="method-args">(crypted, base64=true)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Decrypts data, expects a hash as create with crypt_with_private
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000380-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000380-source">
+
+
+
+ <div class="method-source-code"
+ id="decrypt-with-public-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 102</span>
102: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">decrypt_with_public</span>(<span class="ruby-identifier">crypted</span>, <span class="ruby-identifier">base64</span>=<span class="ruby-keyword kw">true</span>)
110: <span class="ruby-identifier">key</span> = <span class="ruby-identifier">rsa_decrypt_with_public</span>(<span class="ruby-identifier">crypted</span>[<span class="ruby-identifier">:key</span>])
111: <span class="ruby-identifier">aes_decrypt</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">crypted</span>[<span class="ruby-identifier">:data</span>])
112: <span class="ruby-keyword kw">end</span>
-113: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000378" class="method-detail">
- <a name="M000378"></a>
-
- <div class="method-heading">
- <a href="#M000378" class="method-signature">
- <span class="method-name">encrypt_with_private</span><span class="method-args">(plain_text, base64=true)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+113: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="encrypt-with-private-method" class="method-detail ">
+ <a name="M000206"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">encrypt_with_private</span><span
+ class="method-args">(plain_text, base64=true)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Encrypts supplied data using AES and then encrypts using RSA the key and IV
</p>
<p>
Return a hash with everything optionally base 64 encoded
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000378-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000378-source">
+
+
+
+ <div class="method-source-code"
+ id="encrypt-with-private-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 73</span>
73: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">encrypt_with_private</span>(<span class="ruby-identifier">plain_text</span>, <span class="ruby-identifier">base64</span>=<span class="ruby-keyword kw">true</span>)
82: <span class="ruby-keyword kw">end</span>
83:
84: {<span class="ruby-identifier">:key</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">data</span>}
-85: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000377" class="method-detail">
- <a name="M000377"></a>
-
- <div class="method-heading">
- <a href="#M000377" class="method-signature">
- <span class="method-name">encrypt_with_public</span><span class="method-args">(plain_text, base64=true)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+85: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="encrypt-with-public-method" class="method-detail ">
+ <a name="M000205"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">encrypt_with_public</span><span
+ class="method-args">(plain_text, base64=true)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Encrypts supplied data using AES and then encrypts using RSA the key and IV
</p>
<p>
Return a hash with everything optionally base 64 encoded
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000377-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000377-source">
+
+
+
+ <div class="method-source-code"
+ id="encrypt-with-public-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 55</span>
55: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">encrypt_with_public</span>(<span class="ruby-identifier">plain_text</span>, <span class="ruby-identifier">base64</span>=<span class="ruby-keyword kw">true</span>)
64: <span class="ruby-keyword kw">end</span>
65:
66: {<span class="ruby-identifier">:key</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">data</span>}
-67: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000393" class="method-detail">
- <a name="M000393"></a>
-
- <div class="method-heading">
- <a href="#M000393" class="method-signature">
- <span class="method-name">md5</span><span class="method-args">(string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000393-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000393-source">
+67: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="md--method" class="method-detail ">
+ <a name="M000221"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">md5</span><span
+ class="method-args">(string)</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="md--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 199</span>
199: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">md5</span>(<span class="ruby-identifier">string</span>)
200: <span class="ruby-constant">SSL</span>.<span class="ruby-identifier">md5</span>(<span class="ruby-identifier">string</span>)
-201: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000396" class="method-detail">
- <a name="M000396"></a>
-
- <div class="method-heading">
- <a href="#M000396" class="method-signature">
- <span class="method-name">read_key</span><span class="method-args">(type, key=nil, passphrase=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+201: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="read-key-method" class="method-detail ">
+ <a name="M000224"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">read_key</span><span
+ class="method-args">(type, key=nil, passphrase=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Reads either a :public or :private key from disk, uses an optional
passphrase to read the private key
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000396-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000396-source">
+
+
+
+ <div class="method-source-code"
+ id="read-key-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 242</span>
242: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read_key</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">key</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">passphrase</span>=<span class="ruby-keyword kw">nil</span>)
274: <span class="ruby-keyword kw">else</span>
275: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Can only load :public or :private keys"</span>
276: <span class="ruby-keyword kw">end</span>
-277: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000382" class="method-detail">
- <a name="M000382"></a>
-
- <div class="method-heading">
- <a href="#M000382" class="method-signature">
- <span class="method-name">rsa_decrypt_with_private</span><span class="method-args">(crypt_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+277: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rsa-decrypt-with-private-method" class="method-detail ">
+ <a name="M000210"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rsa_decrypt_with_private</span><span
+ class="method-args">(crypt_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Use the private key to RSA decrypt data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000382-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000382-source">
+
+
+
+ <div class="method-source-code"
+ id="rsa-decrypt-with-private-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 123</span>
123: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rsa_decrypt_with_private</span>(<span class="ruby-identifier">crypt_string</span>)
124: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No private key set"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@private_key</span>
125:
126: <span class="ruby-ivar">@private_key</span>.<span class="ruby-identifier">private_decrypt</span>(<span class="ruby-identifier">crypt_string</span>)
-127: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000384" class="method-detail">
- <a name="M000384"></a>
-
- <div class="method-heading">
- <a href="#M000384" class="method-signature">
- <span class="method-name">rsa_decrypt_with_public</span><span class="method-args">(crypt_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+127: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rsa-decrypt-with-public-method" class="method-detail ">
+ <a name="M000212"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rsa_decrypt_with_public</span><span
+ class="method-args">(crypt_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Use the public key to RSA decrypt data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000384-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000384-source">
+
+
+
+ <div class="method-source-code"
+ id="rsa-decrypt-with-public-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 137</span>
137: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rsa_decrypt_with_public</span>(<span class="ruby-identifier">crypt_string</span>)
138: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No public key set"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@public_key</span>
139:
140: <span class="ruby-ivar">@public_key</span>.<span class="ruby-identifier">public_decrypt</span>(<span class="ruby-identifier">crypt_string</span>)
-141: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000383" class="method-detail">
- <a name="M000383"></a>
-
- <div class="method-heading">
- <a href="#M000383" class="method-signature">
- <span class="method-name">rsa_encrypt_with_private</span><span class="method-args">(plain_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+141: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rsa-encrypt-with-private-method" class="method-detail ">
+ <a name="M000211"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rsa_encrypt_with_private</span><span
+ class="method-args">(plain_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Use the private key to RSA encrypt data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000383-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000383-source">
+
+
+
+ <div class="method-source-code"
+ id="rsa-encrypt-with-private-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 130</span>
130: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rsa_encrypt_with_private</span>(<span class="ruby-identifier">plain_string</span>)
131: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No private key set"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@private_key</span>
132:
133: <span class="ruby-ivar">@private_key</span>.<span class="ruby-identifier">private_encrypt</span>(<span class="ruby-identifier">plain_string</span>)
-134: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000381" class="method-detail">
- <a name="M000381"></a>
-
- <div class="method-heading">
- <a href="#M000381" class="method-signature">
- <span class="method-name">rsa_encrypt_with_public</span><span class="method-args">(plain_string)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+134: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rsa-encrypt-with-public-method" class="method-detail ">
+ <a name="M000209"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">rsa_encrypt_with_public</span><span
+ class="method-args">(plain_string)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Use the public key to RSA encrypt data
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000381-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000381-source">
+
+
+
+ <div class="method-source-code"
+ id="rsa-encrypt-with-public-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 116</span>
116: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rsa_encrypt_with_public</span>(<span class="ruby-identifier">plain_string</span>)
117: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No public key set"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@public_key</span>
118:
119: <span class="ruby-ivar">@public_key</span>.<span class="ruby-identifier">public_encrypt</span>(<span class="ruby-identifier">plain_string</span>)
-120: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000387" class="method-detail">
- <a name="M000387"></a>
-
- <div class="method-heading">
- <a href="#M000387" class="method-signature">
- <span class="method-name">sign</span><span class="method-args">(string, base64=false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+120: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="sign-method" class="method-detail ">
+ <a name="M000215"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">sign</span><span
+ class="method-args">(string, base64=false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Signs a string using the private key
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000387-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000387-source">
+
+
+
+ <div class="method-source-code"
+ id="sign-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 168</span>
168: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sign</span>(<span class="ruby-identifier">string</span>, <span class="ruby-identifier">base64</span>=<span class="ruby-keyword kw">false</span>)
169: <span class="ruby-identifier">sig</span> = <span class="ruby-ivar">@private_key</span>.<span class="ruby-identifier">sign</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>.<span class="ruby-identifier">new</span>, <span class="ruby-identifier">string</span>)
170:
171: <span class="ruby-identifier">base64</span> <span class="ruby-value">? </span><span class="ruby-identifier">base64_encode</span>(<span class="ruby-identifier">sig</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">sig</span>
-172: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000388" class="method-detail">
- <a name="M000388"></a>
-
- <div class="method-heading">
- <a href="#M000388" class="method-signature">
- <span class="method-name">verify_signature</span><span class="method-args">(signature, string, base64=false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+172: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="verify-signature-method" class="method-detail ">
+ <a name="M000216"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">verify_signature</span><span
+ class="method-args">(signature, string, base64=false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Using the public key verifies that a string was signed using the private
key
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000388-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000388-source">
+
+
+
+ <div class="method-source-code"
+ id="verify-signature-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/ssl.rb, line 175</span>
175: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">verify_signature</span>(<span class="ruby-identifier">signature</span>, <span class="ruby-identifier">string</span>, <span class="ruby-identifier">base64</span>=<span class="ruby-keyword kw">false</span>)
176: <span class="ruby-identifier">signature</span> = <span class="ruby-identifier">base64_decode</span>(<span class="ruby-identifier">signature</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">base64</span>
177:
178: <span class="ruby-ivar">@public_key</span>.<span class="ruby-identifier">verify</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>.<span class="ruby-identifier">new</span>, <span class="ruby-identifier">signature</span>, <span class="ruby-identifier">string</span>)
-179: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+179: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </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>
-</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>
\ No newline at end of file
+</html>
+
--- /dev/null
+<?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>Module: MCollective::Security</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="module">
+
+ <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/security_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/security.rb">lib/mcollective/security.rb</a></li>
+
+ <li><a href="../lib/mcollective/security/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/security/base.rb">lib/mcollective/security/base.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="Security/Base.html">MCollective::Security::Base</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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="module">MCollective::Security</h1>
+
+ <div id="description">
+ <p>
+<a href="Security.html">Security</a> is implimented using a module
+structure and installations can configure which module they want to use.
+</p>
+<p>
+<a href="Security.html">Security</a> modules deal with various aspects of
+authentication and authorization:
+</p>
+<ul>
+<li>Determines if a filter excludes this host from dealing with a request
+
+</li>
+<li>Serialization and Deserialization of messages
+
+</li>
+<li>Validation of messages against keys, certificates or whatever the class
+choose to impliment
+
+</li>
+<li>Encoding and Decoding of messages
+
+</li>
+</ul>
+<p>
+To impliment a new security class using <a href="SSL.html">SSL</a> for
+example you would inherit from the base class and only impliment:
+</p>
+<ul>
+<li>decodemsg
+
+</li>
+<li>encodereply
+
+</li>
+<li>encoderequest
+
+</li>
+<li>validrequest?
+
+</li>
+</ul>
+<p>
+Each of these methods should increment various stats counters, see the
+default MCollective::Security::Psk module for examples of this
+</p>
+<p>
+Filtering can be extended by providing a new validate_filter? method.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>Class: MCollective::Security::Base</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Security::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/security/base_rb.html">
- lib/mcollective/security/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- <div id="bodyContent">
+ <title>Class: MCollective::Security::Base</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>
- <div id="contextContent">
-
- <div id="description">
- <p>
+</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/security/base_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/security/base.rb">lib/mcollective/security/base.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="#M000353">::inherited</a></li>
+
+ <li><a href="#M000354">::new</a></li>
+
+ <li><a href="#M000361">#callerid</a></li>
+
+ <li><a href="#M000356">#create_reply</a></li>
+
+ <li><a href="#M000357">#create_request</a></li>
+
+ <li><a href="#M000366">#decodemsg</a></li>
+
+ <li><a href="#M000364">#encodereply</a></li>
+
+ <li><a href="#M000363">#encoderequest</a></li>
+
+ <li><a href="#M000359">#should_process_msg?</a></li>
+
+ <li><a href="#M000360">#valid_callerid?</a></li>
+
+ <li><a href="#M000355">#validate_filter?</a></li>
+
+ <li><a href="#M000362">#validrequest?</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::Security::Base</h1>
+
+ <div id="description">
+ <p>
This is a base class the other security modules should inherit from it
handles statistics and validation of messages that should in most cases
apply to all security models.
inherits from this and provides the following methods:
</p>
<p>
-<a href="Base.html#M000271">decodemsg</a> - Decodes a message that was
-received from the middleware <a href="Base.html#M000270">encodereply</a> -
-Encodes a reply message to a previous request message <a
-href="Base.html#M000269">encoderequest</a> - Encodes a <a
-href="Base.html#M000261">new</a> request message <a
-href="Base.html#M000268">validrequest?</a> - Validates a request received
-from the middleware
+decodemsg - Decodes a message that was received from the middleware
+encodereply - Encodes a reply message to a previous request message
+encoderequest - Encodes a new request message validrequest? - Validates a
+request received from the middleware
</p>
<p>
Optionally if you are identifying users by some other means like
-certificate name you can provide your own <a
-href="Base.html#M000267">callerid</a> method that can provide the rest of
-the system with an id, and you would see this id being usable in SimpleRPC
-authorization methods
+certificate name you can provide your own callerid method that can provide
+the rest of the system with an id, and you would see this id being usable
+in SimpleRPC authorization methods
</p>
<p>
-The @initiated_by variable will be set to either :client or :node depending
-on who is using this plugin. This is to help security providers that
-operate in an asymetric mode like public/private key based systems.
+The @<a href="Base.html#initiated_by">initiated_by</a> variable will be set
+to either :client or :node depending on who is using this plugin. This is
+to help security providers that operate in an asymetric mode like
+public/private key based systems.
</p>
<p>
Specifics of each of these are a bit fluid and the interfaces for this is
MCollective::Security::PSK plugin.
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000267">callerid</a>
- <a href="#M000263">create_reply</a>
- <a href="#M000264">create_request</a>
- <a href="#M000271">decodemsg</a>
- <a href="#M000270">encodereply</a>
- <a href="#M000269">encoderequest</a>
- <a href="#M000260">inherited</a>
- <a href="#M000261">new</a>
- <a href="#M000265">should_process_msg?</a>
- <a href="#M000266">valid_callerid?</a>
- <a href="#M000262">validate_filter?</a>
- <a href="#M000268">validrequest?</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">initiated_by</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">stats</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000260" class="method-detail">
- <a name="M000260"></a>
-
- <div class="method-heading">
- <a href="#M000260" class="method-signature">
- <span class="method-name">inherited</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="stats-attribute-method" class="method-detail">
+ <a name="stats"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">stats</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="initiated-by-attribute-method" class="method-detail">
+ <a name="initiated_by"></a>
+
+ <a name="initiated_by="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">initiated_by</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="inherited-method" class="method-detail ">
+ <a name="M000353"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">inherited</span><span
+ class="method-args">(klass)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Register plugins that inherits base
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000260-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000260-source">
+
+
+
+ <div class="method-source-code"
+ id="inherited-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/security/base.rb, line 32</span>
32: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
33: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"security_plugin"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>}
-34: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000261" class="method-detail">
- <a name="M000261"></a>
-
- <div class="method-heading">
- <a href="#M000261" class="method-signature">
- <span class="method-name">new</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Initializes configuration and logging as well as prepare a zero‘d
+34: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="new-method" class="method-detail ">
+ <a name="M000354"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Initializes configuration and logging as well as prepare a zero’d
hash of stats various security methods and filter validators should
increment stats, see MCollective::Security::Psk for a sample
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000261-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000261-source">
+
+
+
+ <div class="method-source-code"
+ id="new-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/security/base.rb, line 38</span>
38: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
39: <span class="ruby-ivar">@config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
40: <span class="ruby-ivar">@log</span> = <span class="ruby-constant">Log</span>
41: <span class="ruby-ivar">@stats</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"global_stats"</span>]
-42: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000267" class="method-detail">
- <a name="M000267"></a>
-
- <div class="method-heading">
- <a href="#M000267" class="method-signature">
- <span class="method-name">callerid</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+42: <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="callerid-method" class="method-detail ">
+ <a name="M000361"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">callerid</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns a unique id for the caller, by default we just use the unix user
id, security plugins can provide their own means of doing ids.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000267-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000267-source">
+
+
+
+ <div class="method-source-code"
+ id="callerid-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/security/base.rb, line 219</span>
219: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">callerid</span>
220: <span class="ruby-node">"uid=#{Process.uid}"</span>
-221: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000263" class="method-detail">
- <a name="M000263"></a>
-
- <div class="method-heading">
- <a href="#M000263" class="method-signature">
- <span class="method-name">create_reply</span><span class="method-args">(reqid, agent, body)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000263-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000263-source">
+221: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="create-reply-method" class="method-detail ">
+ <a name="M000356"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">create_reply</span><span
+ class="method-args">(reqid, agent, body)</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="create-reply-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/security/base.rb, line 167</span>
167: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_reply</span>(<span class="ruby-identifier">reqid</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">body</span>)
172: <span class="ruby-identifier">:senderagent</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">agent</span>,
173: <span class="ruby-identifier">:msgtime</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">utc</span>.<span class="ruby-identifier">to_i</span>,
174: <span class="ruby-identifier">:body</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">body</span>}
-175: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000264" class="method-detail">
- <a name="M000264"></a>
-
- <div class="method-heading">
- <a href="#M000264" class="method-signature">
- <span class="method-name">create_request</span><span class="method-args">(reqid, filter, msg, initiated_by, target_agent, target_collective, ttl=60)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000264-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000264-source">
+175: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="create-request-method" class="method-detail ">
+ <a name="M000357"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">create_request</span><span
+ class="method-args">(reqid, filter, msg, initiated_by, target_agent, target_collective, ttl=60)</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="create-request-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/security/base.rb, line 177</span>
177: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_request</span>(<span class="ruby-identifier">reqid</span>, <span class="ruby-identifier">filter</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">initiated_by</span>, <span class="ruby-identifier">target_agent</span>, <span class="ruby-identifier">target_collective</span>, <span class="ruby-identifier">ttl</span>=<span class="ruby-value">60</span>)
186: <span class="ruby-identifier">:callerid</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">callerid</span>,
187: <span class="ruby-identifier">:ttl</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">ttl</span>,
188: <span class="ruby-identifier">:msgtime</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">utc</span>.<span class="ruby-identifier">to_i</span>}
-189: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000271" class="method-detail">
- <a name="M000271"></a>
-
- <div class="method-heading">
- <a href="#M000271" class="method-signature">
- <span class="method-name">decodemsg</span><span class="method-args">(msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+189: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="decodemsg-method" class="method-detail ">
+ <a name="M000366"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">decodemsg</span><span
+ class="method-args">(msg)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
<a href="../Security.html">Security</a> providers should provide this, see
MCollective::Security::Psk
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000271-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000271-source">
+
+
+
+ <div class="method-source-code"
+ id="decodemsg-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/security/base.rb, line 239</span>
239: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">decodemsg</span>(<span class="ruby-identifier">msg</span>)
240: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"decodemsg is not implemented in #{self.class}"</span>)
-241: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000270" class="method-detail">
- <a name="M000270"></a>
-
- <div class="method-heading">
- <a href="#M000270" class="method-signature">
- <span class="method-name">encodereply</span><span class="method-args">(sender, msg, requestcallerid=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+241: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="encodereply-method" class="method-detail ">
+ <a name="M000364"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">encodereply</span><span
+ class="method-args">(sender, msg, requestcallerid=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
<a href="../Security.html">Security</a> providers should provide this, see
MCollective::Security::Psk
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000270-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000270-source">
+
+
+
+ <div class="method-source-code"
+ id="encodereply-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/security/base.rb, line 234</span>
234: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">encodereply</span>(<span class="ruby-identifier">sender</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">requestcallerid</span>=<span class="ruby-keyword kw">nil</span>)
235: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"encodereply is not implemented in #{self.class}"</span>)
-236: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000269" class="method-detail">
- <a name="M000269"></a>
-
- <div class="method-heading">
- <a href="#M000269" class="method-signature">
- <span class="method-name">encoderequest</span><span class="method-args">(sender, msg, filter={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+236: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="encoderequest-method" class="method-detail ">
+ <a name="M000363"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">encoderequest</span><span
+ class="method-args">(sender, msg, filter={})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
<a href="../Security.html">Security</a> providers should provide this, see
MCollective::Security::Psk
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000269-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000269-source">
+
+
+
+ <div class="method-source-code"
+ id="encoderequest-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/security/base.rb, line 229</span>
229: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">encoderequest</span>(<span class="ruby-identifier">sender</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">filter</span>={})
230: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"encoderequest is not implemented in #{self.class}"</span>)
-231: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000265" class="method-detail">
- <a name="M000265"></a>
-
- <div class="method-heading">
- <a href="#M000265" class="method-signature">
- <span class="method-name">should_process_msg?</span><span class="method-args">(msg, msgid)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+231: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="should-process-msg--method" class="method-detail ">
+ <a name="M000359"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">should_process_msg?</span><span
+ class="method-args">(msg, msgid)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Give a MC::Message instance and a message id this will figure out if you
the incoming message id matches the one the <a
href="../Message.html">Message</a> object is expecting and raise if its not
Mostly used by security plugins to figure out if they should do the hard
work of decrypting etc messages that would only later on be ignored
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000265-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000265-source">
+
+
+
+ <div class="method-source-code"
+ id="should-process-msg--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/security/base.rb, line 196</span>
196: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">should_process_msg?</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">msgid</span>)
203: <span class="ruby-keyword kw">end</span>
204:
205: <span class="ruby-keyword kw">true</span>
-206: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000266" class="method-detail">
- <a name="M000266"></a>
-
- <div class="method-heading">
- <a href="#M000266" class="method-signature">
- <span class="method-name">valid_callerid?</span><span class="method-args">(id)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Validates a <a href="Base.html#M000267">callerid</a>. We do not want to
-allow things like \ and / in callerids since other plugins make assumptions
-that these are safe strings.
+206: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="valid-callerid--method" class="method-detail ">
+ <a name="M000360"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">valid_callerid?</span><span
+ class="method-args">(id)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Validates a callerid. We do not want to allow things like \ and / in
+callerids since other plugins make assumptions that these are safe strings.
</p>
<p>
callerids are generally in the form uid=123 or cert=foo etc so we do that
here but security plugins could override this for some complex uses
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000266-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000266-source">
+
+
+
+ <div class="method-source-code"
+ id="valid-callerid--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/security/base.rb, line 213</span>
213: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_callerid?</span>(<span class="ruby-identifier">id</span>)
214: <span class="ruby-operator">!</span><span class="ruby-operator">!</span><span class="ruby-identifier">id</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^[\w]+=[\w\.\-]+$/</span>)
-215: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000262" class="method-detail">
- <a name="M000262"></a>
-
- <div class="method-heading">
- <a href="#M000262" class="method-signature">
- <span class="method-name">validate_filter?</span><span class="method-args">(filter)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+215: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-filter--method" class="method-detail ">
+ <a name="M000355"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate_filter?</span><span
+ class="method-args">(filter)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Takes a Hash with a filter in it and validates it against host information.
</p>
<p>
</li>
</ul>
<p>
-TODO: Support REGEX and/or multiple filter keys to be AND‘d
+TODO: Support REGEX and/or multiple filter keys to be AND’d
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000262-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000262-source">
+
+
+
+ <div class="method-source-code"
+ id="validate-filter--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/security/base.rb, line 55</span>
55: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_filter?</span>(<span class="ruby-identifier">filter</span>)
162:
163: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
164: <span class="ruby-keyword kw">end</span>
-165: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000268" class="method-detail">
- <a name="M000268"></a>
-
- <div class="method-heading">
- <a href="#M000268" class="method-signature">
- <span class="method-name">validrequest?</span><span class="method-args">(req)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+165: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validrequest--method" class="method-detail ">
+ <a name="M000362"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validrequest?</span><span
+ class="method-args">(req)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
<a href="../Security.html">Security</a> providers should provide this, see
MCollective::Security::Psk
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000268-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000268-source">
+
+
+
+ <div class="method-source-code"
+ id="validrequest--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/security/base.rb, line 224</span>
224: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validrequest?</span>(<span class="ruby-identifier">req</span>)
225: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"validrequest? is not implemented in #{self.class}"</span>)
-226: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+226: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </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>
-</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>
\ No newline at end of file
+</html>
+
--- /dev/null
+<?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::SecurityValidationFailed</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">RuntimeError</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::SecurityValidationFailed</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::Shell</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/shell_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/shell.rb">lib/mcollective/shell.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="#M000358">::new</a></li>
+
+ <li><a href="#M000365">#runcommand</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::Shell</h1>
+
+ <div id="description">
+ <p>
+Wrapper around systemu that handles executing of system commands in a way
+that makes stdout, stderr and status available. Supports timeouts and sets
+a default sane environment.
+</p>
+<pre>
+ s = Shell.new("date", opts)
+ s.runcommand
+ puts s.stdout
+ puts s.stderr
+ puts s.status.exitstatus
+</pre>
+<p>
+Options hash can have:
+</p>
+<pre>
+ cwd - the working directory the command will be run from
+ stdin - a string that will be sent to stdin of the program
+ stdout - a variable that will receive stdout, must support <<
+ stderr - a variable that will receive stdin, must support <<
+ environment - the shell environment, defaults to include LC_ALL=C
+ set to nil to clear the environment even of LC_ALL
+ timeout - a timeout in seconds after which the subprocess is killed,
+ the special value :on_thread_exit kills the subprocess
+ when the invoking thread (typically the agent) has ended
+</pre>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="environment-attribute-method" class="method-detail">
+ <a name="environment"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">environment</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="command-attribute-method" class="method-detail">
+ <a name="command"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">command</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="status-attribute-method" class="method-detail">
+ <a name="status"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">status</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="stdout-attribute-method" class="method-detail">
+ <a name="stdout"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">stdout</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="stderr-attribute-method" class="method-detail">
+ <a name="stderr"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">stderr</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="stdin-attribute-method" class="method-detail">
+ <a name="stdin"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">stdin</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="cwd-attribute-method" class="method-detail">
+ <a name="cwd"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">cwd</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+ </div>
+ </div>
+
+ <div id="timeout-attribute-method" class="method-detail">
+ <a name="timeout"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">timeout</span><span
+ class="attribute-access-type">[R]</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="M000358"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">(command, options={})</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/shell.rb, line 27</span>
+27: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">options</span>={})
+28: <span class="ruby-ivar">@environment</span> = {<span class="ruby-value str">"LC_ALL"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"C"</span>}
+29: <span class="ruby-ivar">@command</span> = <span class="ruby-identifier">command</span>
+30: <span class="ruby-ivar">@status</span> = <span class="ruby-keyword kw">nil</span>
+31: <span class="ruby-ivar">@stdout</span> = <span class="ruby-value str">""</span>
+32: <span class="ruby-ivar">@stderr</span> = <span class="ruby-value str">""</span>
+33: <span class="ruby-ivar">@stdin</span> = <span class="ruby-keyword kw">nil</span>
+34: <span class="ruby-ivar">@cwd</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">tmpdir</span>
+35: <span class="ruby-ivar">@timeout</span> = <span class="ruby-keyword kw">nil</span>
+36:
+37: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opt</span>, <span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
+38: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">opt</span>.<span class="ruby-identifier">to_s</span>
+39: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"stdout"</span>
+40: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"stdout should support <<"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"<<"</span>)
+41: <span class="ruby-ivar">@stdout</span> = <span class="ruby-identifier">val</span>
+42:
+43: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"stderr"</span>
+44: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"stderr should support <<"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"<<"</span>)
+45: <span class="ruby-ivar">@stderr</span> = <span class="ruby-identifier">val</span>
+46:
+47: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"stdin"</span>
+48: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"stdin should be a String"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
+49: <span class="ruby-ivar">@stdin</span> = <span class="ruby-identifier">val</span>
+50:
+51: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"cwd"</span>
+52: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Directory #{val} does not exist"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">val</span>)
+53: <span class="ruby-ivar">@cwd</span> = <span class="ruby-identifier">val</span>
+54:
+55: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"environment"</span>
+56: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">nil?</span>
+57: <span class="ruby-ivar">@environment</span> = {}
+58: <span class="ruby-keyword kw">else</span>
+59: <span class="ruby-ivar">@environment</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">val</span>.<span class="ruby-identifier">dup</span>)
+60: <span class="ruby-keyword kw">end</span>
+61: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"timeout"</span>
+62: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"timeout should be a positive integer or the symbol :on_thread_exit symbol"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">eql?</span>(<span class="ruby-identifier">:on_thread_exit</span>) <span class="ruby-operator">||</span> ( <span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Fixnum</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">val</span><span class="ruby-operator">></span><span class="ruby-value">0</span> )
+63: <span class="ruby-ivar">@timeout</span> = <span class="ruby-identifier">val</span>
+64: <span class="ruby-keyword kw">end</span>
+65: <span class="ruby-keyword kw">end</span>
+66: <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="runcommand-method" class="method-detail ">
+ <a name="M000365"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">runcommand</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Actually does the systemu call passing in the correct environment, stdout
+and stderr
+</p>
+
+
+
+ <div class="method-source-code"
+ id="runcommand-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/shell.rb, line 69</span>
+ 69: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">runcommand</span>
+ 70: <span class="ruby-identifier">opts</span> = {<span class="ruby-value str">"env"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@environment</span>,
+ 71: <span class="ruby-value str">"stdout"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@stdout</span>,
+ 72: <span class="ruby-value str">"stderr"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@stderr</span>,
+ 73: <span class="ruby-value str">"cwd"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@cwd</span>}
+ 74:
+ 75: <span class="ruby-identifier">opts</span>[<span class="ruby-value str">"stdin"</span>] = <span class="ruby-ivar">@stdin</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@stdin</span>
+ 76:
+ 77:
+ 78: <span class="ruby-identifier">thread</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>
+ 79: <span class="ruby-comment cmt"># Start a double fork and exec with systemu which implies a guard thread.</span>
+ 80: <span class="ruby-comment cmt"># If a valid timeout is configured the guard thread will terminate the</span>
+ 81: <span class="ruby-comment cmt"># executing process and reap the pid.</span>
+ 82: <span class="ruby-comment cmt"># If no timeout is specified the process will run to completion with the</span>
+ 83: <span class="ruby-comment cmt"># guard thread reaping the pid on completion.</span>
+ 84: <span class="ruby-ivar">@status</span> = <span class="ruby-identifier">systemu</span>(<span class="ruby-ivar">@command</span>, <span class="ruby-identifier">opts</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">cid</span><span class="ruby-operator">|</span>
+ 85: <span class="ruby-keyword kw">begin</span>
+ 86: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">timeout</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Fixnum</span>)
+ 87: <span class="ruby-comment cmt"># wait for the specified timeout</span>
+ 88: <span class="ruby-identifier">sleep</span> <span class="ruby-identifier">timeout</span>
+ 89: <span class="ruby-keyword kw">else</span>
+ 90: <span class="ruby-comment cmt"># sleep while the agent thread is still alive</span>
+ 91: <span class="ruby-keyword kw">while</span>(<span class="ruby-identifier">thread</span>.<span class="ruby-identifier">alive?</span>)
+ 92: <span class="ruby-identifier">sleep</span> <span class="ruby-value">0</span><span class="ruby-value">.1</span>
+ 93: <span class="ruby-keyword kw">end</span>
+ 94: <span class="ruby-keyword kw">end</span>
+ 95:
+ 96: <span class="ruby-comment cmt"># if the process is still running</span>
+ 97: <span class="ruby-keyword kw">if</span> (<span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">cid</span>))
+ 98: <span class="ruby-comment cmt"># and a timeout was specified</span>
+ 99: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">timeout</span>
+100: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
+101: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value str">'KILL'</span>, <span class="ruby-identifier">cid</span>)
+102: <span class="ruby-keyword kw">else</span>
+103: <span class="ruby-comment cmt"># Kill the process</span>
+104: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value str">'TERM'</span>, <span class="ruby-identifier">cid</span>)
+105: <span class="ruby-identifier">sleep</span> <span class="ruby-value">2</span>
+106: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value str">'KILL'</span>, <span class="ruby-identifier">cid</span>) <span class="ruby-keyword kw">if</span> (<span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">cid</span>))
+107: <span class="ruby-keyword kw">end</span>
+108: <span class="ruby-keyword kw">end</span>
+109: <span class="ruby-comment cmt"># only wait if the parent thread is dead</span>
+110: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">waitpid</span>(<span class="ruby-identifier">cid</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">thread</span>.<span class="ruby-identifier">alive?</span>
+111: <span class="ruby-keyword kw">end</span>
+112: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">SystemExit</span>
+113: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ESRCH</span>
+114: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ECHILD</span>
+115: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Could not reap process '#{cid}'."</span>)
+116: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+117: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">"Unexpected exception received while waiting for child process: #{e.class}: #{e}"</span>)
+118: <span class="ruby-keyword kw">end</span>
+119: <span class="ruby-keyword kw">end</span>
+120: <span class="ruby-ivar">@status</span>.<span class="ruby-identifier">thread</span>.<span class="ruby-identifier">kill</span>
+121: <span class="ruby-ivar">@status</span>
+122: <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>
+
--- /dev/null
+<?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>Module: MCollective::Translatable</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="module">
+
+ <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/translatable_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/translatable.rb">lib/mcollective/translatable.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000235">#log_code</a></li>
+
+ <li><a href="#M000237">#logexception</a></li>
+
+ <li><a href="#M000236">#raise_code</a></li>
+
+ <li><a href="#M000234">#t</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="module">MCollective::Translatable</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="log-code-method" class="method-detail ">
+ <a name="M000235"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">log_code</span><span
+ class="method-args">(msgid, default, level, args={})</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="log-code-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 7</span>
+ 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>={})
+ 8: <span class="ruby-identifier">msg</span> = <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">msgid</span>, <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))]
+ 9:
+10: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">caller</span>[<span class="ruby-value">1</span>]))
+11: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="logexception-method" class="method-detail ">
+ <a name="M000237"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">logexception</span><span
+ class="method-args">(msgid, default, level, e, backtrace=false)</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="logexception-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 20</span>
+20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">e</span>, <span class="ruby-identifier">backtrace</span>=<span class="ruby-keyword kw">false</span>)
+21: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">e</span>, <span class="ruby-identifier">backtrace</span>)
+22: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="raise-code-method" class="method-detail ">
+ <a name="M000236"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">raise_code</span><span
+ class="method-args">(msgid, default, level, args={})</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="raise-code-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 13</span>
+13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>={})
+14: <span class="ruby-identifier">exception</span> = <span class="ruby-constant">CodedError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>)
+15: <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">set_backtrace</span> <span class="ruby-identifier">caller</span>
+16:
+17: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">exception</span>
+18: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="t-method" class="method-detail ">
+ <a name="M000234"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">t</span><span
+ class="method-args">(msgid, default, args={})</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="t-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 3</span>
+3: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">args</span>={})
+4: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))
+5: <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>
+
--- /dev/null
+<?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::UnixDaemon</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/unix_daemon_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/unix_daemon.rb">lib/mcollective/unix_daemon.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="#M000346">::daemonize</a></li>
+
+ <li><a href="#M000347">::daemonize_runner</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::UnixDaemon</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="daemonize-method" class="method-detail ">
+ <a name="M000346"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">daemonize</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Daemonize the current process
+</p>
+
+
+
+ <div class="method-source-code"
+ id="daemonize-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/unix_daemon.rb, line 4</span>
+ 4: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">daemonize</span>
+ 5: <span class="ruby-identifier">fork</span> <span class="ruby-keyword kw">do</span>
+ 6: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">setsid</span>
+ 7: <span class="ruby-identifier">exit</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">fork</span>
+ 8: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-value str">'/tmp'</span>)
+ 9: <span class="ruby-constant">STDIN</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-value str">'/dev/null'</span>)
+10: <span class="ruby-constant">STDOUT</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-value str">'/dev/null'</span>, <span class="ruby-value str">'a'</span>)
+11: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-value str">'/dev/null'</span>, <span class="ruby-value str">'a'</span>)
+12:
+13: <span class="ruby-keyword kw">yield</span>
+14: <span class="ruby-keyword kw">end</span>
+15: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="daemonize-runner-method" class="method-detail ">
+ <a name="M000347"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">daemonize_runner</span><span
+ class="method-args">(pid=nil)</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="daemonize-runner-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/unix_daemon.rb, line 17</span>
+17: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">daemonize_runner</span>(<span class="ruby-identifier">pid</span>=<span class="ruby-keyword kw">nil</span>)
+18: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"The Unix Daemonizer can not be used on the Windows Platform"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
+19:
+20: <span class="ruby-constant">UnixDaemon</span>.<span class="ruby-identifier">daemonize</span> <span class="ruby-keyword kw">do</span>
+21: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span>
+22: <span class="ruby-keyword kw">begin</span>
+23: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">pid</span>, <span class="ruby-value str">'w'</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-constant">Process</span>.<span class="ruby-identifier">pid</span>) }
+24: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+25: <span class="ruby-keyword kw">end</span>
+26: <span class="ruby-keyword kw">end</span>
+27:
+28: <span class="ruby-keyword kw">begin</span>
+29: <span class="ruby-identifier">runner</span> = <span class="ruby-constant">Runner</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">nil</span>)
+30: <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">run</span>
+31: <span class="ruby-keyword kw">ensure</span>
+32: <span class="ruby-constant">File</span>.<span class="ruby-identifier">unlink</span>(<span class="ruby-identifier">pid</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">pid</span>)
+33: <span class="ruby-keyword kw">end</span>
+34: <span class="ruby-keyword kw">end</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>
+
--- /dev/null
+<?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::UnknownRPCAction</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">RPCError</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::UnknownRPCAction</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::UnknownRPCError</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">RPCError</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::UnknownRPCError</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>Module: MCollective::Util</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Util</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/util_rb.html">
- lib/mcollective/util.rb
- </a>
- <br />
- </td>
- </tr>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- </table>
- </div>
- <!-- banner header -->
+ <title>Module: MCollective::Util</title>
- <div id="bodyContent">
+ <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>
-
- <div id="contextContent">
-
- <div id="description">
- <p>
+</head>
+<body class="module">
+
+ <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/util_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/util.rb">lib/mcollective/util.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000328">::absolute_path?</a></li>
+
+ <li><a href="#M000318">::align_text</a></li>
+
+ <li><a href="#M000313">::color</a></li>
+
+ <li><a href="#M000315">::colorize</a></li>
+
+ <li><a href="#M000325">::command_in_path?</a></li>
+
+ <li><a href="#M000303">::config_file_for_user</a></li>
+
+ <li><a href="#M000304">::default_options</a></li>
+
+ <li><a href="#M000301">::empty_filter</a></li>
+
+ <li><a href="#M000300">::empty_filter?</a></li>
+
+ <li><a href="#M000297">::get_fact</a></li>
+
+ <li><a href="#M000294">::has_agent?</a></li>
+
+ <li><a href="#M000296">::has_cf_class?</a></li>
+
+ <li><a href="#M000298">::has_fact?</a></li>
+
+ <li><a href="#M000299">::has_identity?</a></li>
+
+ <li><a href="#M000308">::loadclass</a></li>
+
+ <li><a href="#M000305">::make_subscriptions</a></li>
+
+ <li><a href="#M000317">::mcollective_version</a></li>
+
+ <li><a href="#M000309">::parse_fact_string</a></li>
+
+ <li><a href="#M000316">::ruby_version</a></li>
+
+ <li><a href="#M000295">::setup_windows_sleeper</a></li>
+
+ <li><a href="#M000311">::shellescape</a></li>
+
+ <li><a href="#M000329">::str_to_bool</a></li>
+
+ <li><a href="#M000306">::subscribe</a></li>
+
+ <li><a href="#M000330">::t</a></li>
+
+ <li><a href="#M000331">::templatepath</a></li>
+
+ <li><a href="#M000322">::terminal_dimensions</a></li>
+
+ <li><a href="#M000307">::unsubscribe</a></li>
+
+ <li><a href="#M000326">::versioncmp</a></li>
+
+ <li><a href="#M000312">::windows?</a></li>
+
+ <li><a href="#M000302">::windows_prefix</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="module">MCollective::Util</h1>
+
+ <div id="description">
+ <p>
Some basic utility helper methods useful to clients, agents, runner etc.
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
+ </div>
- <div class="name-list">
- <a href="#M000307">absolute_path?</a>
- <a href="#M000303">align_text</a>
- <a href="#M000299">color</a>
- <a href="#M000300">colorize</a>
- <a href="#M000305">command_in_path?</a>
- <a href="#M000290">config_file_for_user</a>
- <a href="#M000291">default_options</a>
- <a href="#M000288">empty_filter</a>
- <a href="#M000287">empty_filter?</a>
- <a href="#M000284">get_fact</a>
- <a href="#M000281">has_agent?</a>
- <a href="#M000283">has_cf_class?</a>
- <a href="#M000285">has_fact?</a>
- <a href="#M000286">has_identity?</a>
- <a href="#M000295">loadclass</a>
- <a href="#M000292">make_subscriptions</a>
- <a href="#M000302">mcollective_version</a>
- <a href="#M000296">parse_fact_string</a>
- <a href="#M000301">ruby_version</a>
- <a href="#M000282">setup_windows_sleeper</a>
- <a href="#M000297">shellescape</a>
- <a href="#M000308">str_to_bool</a>
- <a href="#M000293">subscribe</a>
- <a href="#M000309">t</a>
- <a href="#M000310">templatepath</a>
- <a href="#M000304">terminal_dimensions</a>
- <a href="#M000294">unsubscribe</a>
- <a href="#M000306">versioncmp</a>
- <a href="#M000298">windows?</a>
- <a href="#M000289">windows_prefix</a>
- </div>
- </div>
+ <!-- Constants -->
+
- </div>
+ <!-- Attributes -->
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
- <!-- if includes -->
+
+ <div id="absolute-path--method" class="method-detail ">
+ <a name="M000328"></a>
- <div id="section">
+ <div class="method-heading">
+
+ <span class="method-name">absolute_path?</span><span
+ class="method-args">(path, separator=File::SEPARATOR, alt_separator=File::ALT_SEPARATOR)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000307" class="method-detail">
- <a name="M000307"></a>
-
- <div class="method-heading">
- <a href="#M000307" class="method-signature">
- <span class="method-name">absolute_path?</span><span class="method-args">(path, separator=File::SEPARATOR, alt_separator=File::ALT_SEPARATOR)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-we should really use Pathname#absolute? but it‘s not in all the ruby
+ <div class="method-description">
+
+ <p>
+we should really use Pathname#absolute? but it’s not in all the ruby
versions we support and it comes down to roughly this
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000307-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000307-source">
+
+
+
+ <div class="method-source-code"
+ id="absolute-path--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 464</span>
464: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">absolute_path?</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">separator</span>=<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>, <span class="ruby-identifier">alt_separator</span>=<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">ALT_SEPARATOR</span>)
469: <span class="ruby-keyword kw">end</span>
470:
471: <span class="ruby-operator">!</span><span class="ruby-operator">!</span><span class="ruby-identifier">path</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">path_matcher</span>)
-472: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000303" class="method-detail">
- <a name="M000303"></a>
-
- <div class="method-heading">
- <a href="#M000303" class="method-signature">
- <span class="method-name">align_text</span><span class="method-args">(text, console_cols = nil, preamble = 5)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+472: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="align-text-method" class="method-detail ">
+ <a name="M000318"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">align_text</span><span
+ class="method-args">(text, console_cols = nil, preamble = 5)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns an aligned_string of text relative to the size of the terminal
window. If a line in the string exceeds the width of the terminal window
the line will be chopped off at the whitespace chacter closest to the end
passed. All strings will also be left aligned with 5 whitespace characters
by default.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000303-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000303-source">
+
+
+
+ <div class="method-source-code"
+ id="align-text-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 310</span>
310: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">align_text</span>(<span class="ruby-identifier">text</span>, <span class="ruby-identifier">console_cols</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">preamble</span> = <span class="ruby-value">5</span>)
387: <span class="ruby-keyword kw">end</span>
388:
389: <span class="ruby-identifier">text</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n"</span>)
-390: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000299" class="method-detail">
- <a name="M000299"></a>
-
- <div class="method-heading">
- <a href="#M000299" class="method-signature">
- <span class="method-name">color</span><span class="method-args">(code)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Return <a href="Util.html#M000299">color</a> codes, if the config color=
-option is false just return a empty string
+390: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="color-method" class="method-detail ">
+ <a name="M000313"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">color</span><span
+ class="method-args">(code)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Return color codes, if the config color= option is false just return a
+empty string
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000299-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000299-source">
+
+
+
+ <div class="method-source-code"
+ id="color-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 270</span>
270: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">code</span>)
282: <span class="ruby-keyword kw">else</span>
283: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span>
284: <span class="ruby-keyword kw">end</span>
-285: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000300" class="method-detail">
- <a name="M000300"></a>
-
- <div class="method-heading">
- <a href="#M000300" class="method-signature">
- <span class="method-name">colorize</span><span class="method-args">(code, msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Helper to return a string in specific <a href="Util.html#M000299">color</a>
+285: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="colorize-method" class="method-detail ">
+ <a name="M000315"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">colorize</span><span
+ class="method-args">(code, msg)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Helper to return a string in specific color
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000300-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000300-source">
+
+
+
+ <div class="method-source-code"
+ id="colorize-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 288</span>
288: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">code</span>, <span class="ruby-identifier">msg</span>)
289: <span class="ruby-value str">"%s%s%s"</span> <span class="ruby-operator">%</span> [ <span class="ruby-identifier">color</span>(<span class="ruby-identifier">code</span>), <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">color</span>(<span class="ruby-identifier">:reset</span>) ]
-290: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000305" class="method-detail">
- <a name="M000305"></a>
-
- <div class="method-heading">
- <a href="#M000305" class="method-signature">
- <span class="method-name">command_in_path?</span><span class="method-args">(command)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+290: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="command-in-path--method" class="method-detail ">
+ <a name="M000325"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">command_in_path?</span><span
+ class="method-args">(command)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Checks in PATH returns true if the command is found
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000305-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000305-source">
+
+
+
+ <div class="method-source-code"
+ id="command-in-path--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 417</span>
417: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">command_in_path?</span>(<span class="ruby-identifier">command</span>)
420: <span class="ruby-keyword kw">end</span>
421:
422: <span class="ruby-identifier">found</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-keyword kw">true</span>)
-423: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000290" class="method-detail">
- <a name="M000290"></a>
-
- <div class="method-heading">
- <a href="#M000290" class="method-signature">
- <span class="method-name">config_file_for_user</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+423: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="config-file-for-user-method" class="method-detail ">
+ <a name="M000303"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">config_file_for_user</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Picks a config file defaults to ~/.mcollective else
/etc/mcollective/client.cfg
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000290-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000290-source">
+
+
+
+ <div class="method-source-code"
+ id="config-file-for-user-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 148</span>
148: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">config_file_for_user</span>
168: <span class="ruby-keyword kw">end</span>
169:
170: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">config</span>
-171: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000291" class="method-detail">
- <a name="M000291"></a>
-
- <div class="method-heading">
- <a href="#M000291" class="method-signature">
- <span class="method-name">default_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+171: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="default-options-method" class="method-detail ">
+ <a name="M000304"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">default_options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Creates a standard options hash
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000291-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000291-source">
+
+
+
+ <div class="method-source-code"
+ id="default-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 174</span>
174: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">default_options</span>
180: <span class="ruby-identifier">:discovery_method</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>,
181: <span class="ruby-identifier">:discovery_options</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">default_discovery_options</span>,
182: <span class="ruby-identifier">:filter</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">empty_filter</span>}
-183: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000288" class="method-detail">
- <a name="M000288"></a>
-
- <div class="method-heading">
- <a href="#M000288" class="method-signature">
- <span class="method-name">empty_filter</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+183: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="empty-filter-method" class="method-detail ">
+ <a name="M000301"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">empty_filter</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Creates an empty filter
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000288-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000288-source">
+
+
+
+ <div class="method-source-code"
+ id="empty-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 132</span>
132: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">empty_filter</span>
135: <span class="ruby-value str">"agent"</span> =<span class="ruby-operator">></span> [],
136: <span class="ruby-value str">"identity"</span> =<span class="ruby-operator">></span> [],
137: <span class="ruby-value str">"compound"</span> =<span class="ruby-operator">></span> []}
-138: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000287" class="method-detail">
- <a name="M000287"></a>
-
- <div class="method-heading">
- <a href="#M000287" class="method-signature">
- <span class="method-name">empty_filter?</span><span class="method-args">(filter)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+138: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="empty-filter--method" class="method-detail ">
+ <a name="M000300"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">empty_filter?</span><span
+ class="method-args">(filter)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Checks if the passed in filter is an empty one
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000287-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000287-source">
+
+
+
+ <div class="method-source-code"
+ id="empty-filter--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 127</span>
127: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">empty_filter?</span>(<span class="ruby-identifier">filter</span>)
128: <span class="ruby-identifier">filter</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">empty_filter</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">filter</span> <span class="ruby-operator">==</span> {}
-129: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000284" class="method-detail">
- <a name="M000284"></a>
-
- <div class="method-heading">
- <a href="#M000284" class="method-signature">
- <span class="method-name">get_fact</span><span class="method-args">(fact)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+129: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="get-fact-method" class="method-detail ">
+ <a name="M000297"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">get_fact</span><span
+ class="method-args">(fact)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Gets the value of a specific fact, mostly just a duplicate of <a
-href="Facts.html#M000017">MCollective::Facts.get_fact</a> but it kind of
+href="Facts.html#M000483">MCollective::Facts.get_fact</a> but it kind of
goes with the other classes here
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000284-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000284-source">
+
+
+
+ <div class="method-source-code"
+ id="get-fact-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 63</span>
63: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
64: <span class="ruby-constant">Facts</span>.<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
-65: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000281" class="method-detail">
- <a name="M000281"></a>
-
- <div class="method-heading">
- <a href="#M000281" class="method-signature">
- <span class="method-name">has_agent?</span><span class="method-args">(agent)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+65: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-agent--method" class="method-detail ">
+ <a name="M000294"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_agent?</span><span
+ class="method-args">(agent)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Finds out if this <a href="../MCollective.html">MCollective</a> has an
agent by the name passed
</p>
<p>
-If the passed name starts with a / it‘s assumed to be regex and will
+If the passed name starts with a / it’s assumed to be regex and will
use regex to match
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000281-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000281-source">
+
+
+
+ <div class="method-source-code"
+ id="has-agent--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 10</span>
10: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_agent?</span>(<span class="ruby-identifier">agent</span>)
21: <span class="ruby-keyword kw">end</span>
22:
23: <span class="ruby-keyword kw">false</span>
-24: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000283" class="method-detail">
- <a name="M000283"></a>
-
- <div class="method-heading">
- <a href="#M000283" class="method-signature">
- <span class="method-name">has_cf_class?</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+24: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-cf-class--method" class="method-detail ">
+ <a name="M000296"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_cf_class?</span><span
+ class="method-args">(klass)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Checks if this node has a configuration management class by parsing the a
text file with just a list of classes, recipes, roles etc. This is ala the
classes.txt from puppet.
</p>
<p>
-If the passed name starts with a / it‘s assumed to be regex and will
+If the passed name starts with a / it’s assumed to be regex and will
use regex to match
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000283-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000283-source">
+
+
+
+ <div class="method-source-code"
+ id="has-cf-class--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 40</span>
40: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_cf_class?</span>(<span class="ruby-identifier">klass</span>)
56: <span class="ruby-keyword kw">end</span>
57:
58: <span class="ruby-keyword kw">false</span>
-59: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000285" class="method-detail">
- <a name="M000285"></a>
-
- <div class="method-heading">
- <a href="#M000285" class="method-signature">
- <span class="method-name">has_fact?</span><span class="method-args">(fact, value, operator)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+59: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-fact--method" class="method-detail ">
+ <a name="M000298"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_fact?</span><span
+ class="method-args">(fact, value, operator)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Compares fact == value,
</p>
<p>
-If the passed value starts with a / it‘s assumed to be regex and will
+If the passed value starts with a / it’s assumed to be regex and will
use regex to match
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000285-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000285-source">
+
+
+
+ <div class="method-source-code"
+ id="has-fact--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 71</span>
71: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_fact?</span>(<span class="ruby-identifier">fact</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">operator</span>)
105: <span class="ruby-keyword kw">end</span>
106:
107: <span class="ruby-keyword kw">false</span>
-108: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000286" class="method-detail">
- <a name="M000286"></a>
-
- <div class="method-heading">
- <a href="#M000286" class="method-signature">
- <span class="method-name">has_identity?</span><span class="method-args">(identity)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+108: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-identity--method" class="method-detail ">
+ <a name="M000299"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_identity?</span><span
+ class="method-args">(identity)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Checks if the configured identity matches the one supplied
</p>
<p>
-If the passed name starts with a / it‘s assumed to be regex and will
+If the passed name starts with a / it’s assumed to be regex and will
use regex to match
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000286-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000286-source">
+
+
+
+ <div class="method-source-code"
+ id="has-identity--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 114</span>
114: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_identity?</span>(<span class="ruby-identifier">identity</span>)
121: <span class="ruby-keyword kw">end</span>
122:
123: <span class="ruby-keyword kw">false</span>
-124: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000295" class="method-detail">
- <a name="M000295"></a>
-
- <div class="method-heading">
- <a href="#M000295" class="method-signature">
- <span class="method-name">loadclass</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+124: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="loadclass-method" class="method-detail ">
+ <a name="M000308"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">loadclass</span><span
+ class="method-args">(klass)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Wrapper around <a
-href="PluginManager.html#M000034">PluginManager.loadclass</a>
+href="PluginManager.html#M000084">PluginManager.loadclass</a>
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000295-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000295-source">
+
+
+
+ <div class="method-source-code"
+ id="loadclass-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 224</span>
224: <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>)
225: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-identifier">klass</span>)
-226: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000292" class="method-detail">
- <a name="M000292"></a>
-
- <div class="method-heading">
- <a href="#M000292" class="method-signature">
- <span class="method-name">make_subscriptions</span><span class="method-args">(agent, type, collective=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000292-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000292-source">
+226: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="make-subscriptions-method" class="method-detail ">
+ <a name="M000305"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">make_subscriptions</span><span
+ class="method-args">(agent, type, collective=nil)</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="make-subscriptions-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 185</span>
185: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">make_subscriptions</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">collective</span>=<span class="ruby-keyword kw">nil</span>)
196:
197: [{<span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type</span>, <span class="ruby-identifier">:collective</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">collective</span>}]
198: <span class="ruby-keyword kw">end</span>
-199: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000302" class="method-detail">
- <a name="M000302"></a>
-
- <div class="method-heading">
- <a href="#M000302" class="method-signature">
- <span class="method-name">mcollective_version</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000302-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000302-source">
+199: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="mcollective-version-method" class="method-detail ">
+ <a name="M000317"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">mcollective_version</span><span
+ class="method-args">()</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="mcollective-version-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 298</span>
298: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">mcollective_version</span>
299: <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>
-300: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000296" class="method-detail">
- <a name="M000296"></a>
-
- <div class="method-heading">
- <a href="#M000296" class="method-signature">
- <span class="method-name">parse_fact_string</span><span class="method-args">(fact)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+300: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="parse-fact-string-method" class="method-detail ">
+ <a name="M000309"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">parse_fact_string</span><span
+ class="method-args">(fact)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Parse a fact filter string like foo=bar into the tuple hash thats needed
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000296-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000296-source">
+
+
+
+ <div class="method-source-code"
+ id="parse-fact-string-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 229</span>
229: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">parse_fact_string</span>(<span class="ruby-identifier">fact</span>)
240: <span class="ruby-keyword kw">else</span>
241: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Could not parse fact #{fact} it does not appear to be in a valid format"</span>
242: <span class="ruby-keyword kw">end</span>
-243: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000301" class="method-detail">
- <a name="M000301"></a>
-
- <div class="method-heading">
- <a href="#M000301" class="method-signature">
- <span class="method-name">ruby_version</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+243: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="ruby-version-method" class="method-detail ">
+ <a name="M000316"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">ruby_version</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns the current ruby version as per RUBY_VERSION, mostly doing this
here to aid testing
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000301-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000301-source">
+
+
+
+ <div class="method-source-code"
+ id="ruby-version-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 294</span>
294: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ruby_version</span>
295: <span class="ruby-constant">RUBY_VERSION</span>
-296: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000282" class="method-detail">
- <a name="M000282"></a>
-
- <div class="method-heading">
- <a href="#M000282" class="method-signature">
- <span class="method-name">setup_windows_sleeper</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-On windows ^c can‘<a href="Util.html#M000309">t</a> interrupt the VM
-if its blocking on IO, so this sets up a dummy thread that sleeps and this
-will have the end result of being interruptable at least once a second.
-This is a common pattern found in Rails etc
+296: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="setup-windows-sleeper-method" class="method-detail ">
+ <a name="M000295"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">setup_windows_sleeper</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+On windows ^c can’t interrupt the VM if its blocking on IO, so this
+sets up a dummy thread that sleeps and this will have the end result of
+being interruptable at least once a second. This is a common pattern found
+in Rails etc
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000282-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000282-source">
+
+
+
+ <div class="method-source-code"
+ id="setup-windows-sleeper-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 30</span>
30: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">setup_windows_sleeper</span>
31: <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> { <span class="ruby-identifier">loop</span> { <span class="ruby-identifier">sleep</span> <span class="ruby-value">1</span> } } <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
-32: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000297" class="method-detail">
- <a name="M000297"></a>
-
- <div class="method-heading">
- <a href="#M000297" class="method-signature">
- <span class="method-name">shellescape</span><span class="method-args">(str)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Escapes a string so it‘s safe to use in system() or backticks
+32: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="shellescape-method" class="method-detail ">
+ <a name="M000311"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">shellescape</span><span
+ class="method-args">(str)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Escapes a string so it’s safe to use in system() or backticks
</p>
<p>
-Taken from Shellwords#shellescape since it‘s only in a few ruby
+Taken from Shellwords#shellescape since it’s only in a few ruby
versions
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000297-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000297-source">
+
+
+
+ <div class="method-source-code"
+ id="shellescape-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 248</span>
248: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">shellescape</span>(<span class="ruby-identifier">str</span>)
259: <span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/\n/</span>, <span class="ruby-value str">"'\n'"</span>)
260:
261: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">str</span>
-262: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000308" class="method-detail">
- <a name="M000308"></a>
-
- <div class="method-heading">
- <a href="#M000308" class="method-signature">
- <span class="method-name">str_to_bool</span><span class="method-args">(val)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Converts a string into a boolean value Strings matching 1,y,yes,true or <a
-href="Util.html#M000309">t</a> will return TrueClass Any other value will
-return FalseClass
+262: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="str-to-bool-method" class="method-detail ">
+ <a name="M000329"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">str_to_bool</span><span
+ class="method-args">(val)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Converts a string into a boolean value Strings matching 1,y,yes,true or t
+will return TrueClass Any other value will return FalseClass
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000308-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000308-source">
+
+
+
+ <div class="method-source-code"
+ id="str-to-bool-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 477</span>
477: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
483: <span class="ruby-keyword kw">else</span>
484: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC42</span>, <span class="ruby-value str">"Cannot convert string value '%{value}' into a boolean."</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">clean_val</span>)
485: <span class="ruby-keyword kw">end</span>
-486: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000293" class="method-detail">
- <a name="M000293"></a>
-
- <div class="method-heading">
- <a href="#M000293" class="method-signature">
- <span class="method-name">subscribe</span><span class="method-args">(targets)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Helper to <a href="Util.html#M000293">subscribe</a> to a topic on multiple
-collectives or just one
+486: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="subscribe-method" class="method-detail ">
+ <a name="M000306"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">subscribe</span><span
+ class="method-args">(targets)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Helper to subscribe to a topic on multiple collectives or just one
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000293-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000293-source">
+
+
+
+ <div class="method-source-code"
+ id="subscribe-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 202</span>
202: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">targets</span>)
207: <span class="ruby-identifier">targets</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">target</span><span class="ruby-operator">|</span>
208: <span class="ruby-identifier">connection</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">target</span>[<span class="ruby-identifier">:agent</span>], <span class="ruby-identifier">target</span>[<span class="ruby-identifier">:type</span>], <span class="ruby-identifier">target</span>[<span class="ruby-identifier">:collective</span>])
209: <span class="ruby-keyword kw">end</span>
-210: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000309" class="method-detail">
- <a name="M000309"></a>
-
- <div class="method-heading">
- <a href="#M000309" class="method-signature">
- <span class="method-name">t</span><span class="method-args">(msgid, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+210: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="t-method" class="method-detail ">
+ <a name="M000330"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">t</span><span
+ class="method-args">(msgid, args={})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Looks up and interprolate the hash values into a i18n string
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000309-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000309-source">
+
+
+
+ <div class="method-source-code"
+ id="t-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 489</span>
489: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>={})
492: <span class="ruby-keyword kw">else</span>
493: <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>)
494: <span class="ruby-keyword kw">end</span>
-495: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000310" class="method-detail">
- <a name="M000310"></a>
-
- <div class="method-heading">
- <a href="#M000310" class="method-signature">
- <span class="method-name">templatepath</span><span class="method-args">(template_file)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+495: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="templatepath-method" class="method-detail ">
+ <a name="M000331"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">templatepath</span><span
+ class="method-args">(template_file)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Looks up the template directory and returns its full path
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000310-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000310-source">
+
+
+
+ <div class="method-source-code"
+ id="templatepath-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 498</span>
498: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">templatepath</span>(<span class="ruby-identifier">template_file</span>)
502:
503: <span class="ruby-identifier">template_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"/etc/mcollective"</span>, <span class="ruby-identifier">template_file</span>)
504: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">template_path</span>
-505: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000304" class="method-detail">
- <a name="M000304"></a>
-
- <div class="method-heading">
- <a href="#M000304" class="method-signature">
- <span class="method-name">terminal_dimensions</span><span class="method-args">(stdout = STDOUT, environment = ENV)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+505: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="terminal-dimensions-method" class="method-detail ">
+ <a name="M000322"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">terminal_dimensions</span><span
+ class="method-args">(stdout = STDOUT, environment = ENV)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Figures out the columns and lines of the current tty
</p>
<p>
-Returns [0, 0] if it can‘<a href="Util.html#M000309">t</a> figure it
-out or if you‘re not running on a tty
+Returns [0, 0] if it can’t figure it out or if you’re not
+running on a tty
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000304-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000304-source">
+
+
+
+ <div class="method-source-code"
+ id="terminal-dimensions-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 396</span>
396: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">terminal_dimensions</span>(<span class="ruby-identifier">stdout</span> = <span class="ruby-constant">STDOUT</span>, <span class="ruby-identifier">environment</span> = <span class="ruby-constant">ENV</span>)
411: <span class="ruby-keyword kw">end</span>
412: <span class="ruby-keyword kw">rescue</span>
413: [<span class="ruby-value">0</span>, <span class="ruby-value">0</span>]
-414: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000294" class="method-detail">
- <a name="M000294"></a>
-
- <div class="method-heading">
- <a href="#M000294" class="method-signature">
- <span class="method-name">unsubscribe</span><span class="method-args">(targets)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Helper to <a href="Util.html#M000294">unsubscribe</a> to a topic on
-multiple collectives or just one
+414: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="unsubscribe-method" class="method-detail ">
+ <a name="M000307"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">unsubscribe</span><span
+ class="method-args">(targets)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Helper to unsubscribe to a topic on multiple collectives or just one
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000294-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000294-source">
+
+
+
+ <div class="method-source-code"
+ id="unsubscribe-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 213</span>
213: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">unsubscribe</span>(<span class="ruby-identifier">targets</span>)
218: <span class="ruby-identifier">targets</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">target</span><span class="ruby-operator">|</span>
219: <span class="ruby-identifier">connection</span>.<span class="ruby-identifier">unsubscribe</span>(<span class="ruby-identifier">target</span>[<span class="ruby-identifier">:agent</span>], <span class="ruby-identifier">target</span>[<span class="ruby-identifier">:type</span>], <span class="ruby-identifier">target</span>[<span class="ruby-identifier">:collective</span>])
220: <span class="ruby-keyword kw">end</span>
-221: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000306" class="method-detail">
- <a name="M000306"></a>
-
- <div class="method-heading">
- <a href="#M000306" class="method-signature">
- <span class="method-name">versioncmp</span><span class="method-args">(version_a, version_b)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+221: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="versioncmp-method" class="method-detail ">
+ <a name="M000326"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">versioncmp</span><span
+ class="method-args">(version_a, version_b)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
compare two software versions as commonly found in package versions.
</p>
<p>
-returns 0 if a == b returns -1 if a < b returns 1 if a > b
+returns 0 if a == b returns -1 if a < b returns 1 if a > b
</p>
<p>
Code originally from Puppet
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000306-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000306-source">
+
+
+
+ <div class="method-source-code"
+ id="versioncmp-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 433</span>
433: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">versioncmp</span>(<span class="ruby-identifier">version_a</span>, <span class="ruby-identifier">version_b</span>)
457: <span class="ruby-keyword kw">end</span>
458:
459: <span class="ruby-identifier">version_a</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">version_b</span>;
-460: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000298" class="method-detail">
- <a name="M000298"></a>
-
- <div class="method-heading">
- <a href="#M000298" class="method-signature">
- <span class="method-name">windows?</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000298-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000298-source">
+460: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="windows--method" class="method-detail ">
+ <a name="M000312"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">windows?</span><span
+ class="method-args">()</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="windows--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 264</span>
264: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">windows?</span>
265: <span class="ruby-operator">!</span><span class="ruby-operator">!</span>(<span class="ruby-constant">RbConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">CONFIG</span>[<span class="ruby-value str">'host_os'</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/mswin|win32|dos|mingw|cygwin/i</span>)
-266: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000289" class="method-detail">
- <a name="M000289"></a>
-
- <div class="method-heading">
- <a href="#M000289" class="method-signature">
- <span class="method-name">windows_prefix</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+266: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="windows-prefix-method" class="method-detail ">
+ <a name="M000302"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">windows_prefix</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns the PuppetLabs mcollective path for windows
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000289-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000289-source">
+
+
+
+ <div class="method-source-code"
+ id="windows-prefix-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 141</span>
141: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">windows_prefix</span>
142: <span class="ruby-identifier">require</span> <span class="ruby-value str">'win32/dir'</span>
143: <span class="ruby-identifier">prefix</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">Dir</span><span class="ruby-operator">::</span><span class="ruby-constant">COMMON_APPDATA</span>, <span class="ruby-value str">"PuppetLabs"</span>, <span class="ruby-value str">"mcollective"</span>)
-144: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+144: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </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>
-</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>
\ No newline at end of file
+</html>
+
--- /dev/null
+<?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>Module: MCollective::Validator</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="module">
+
+ <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/validator_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/validator.rb">lib/mcollective/validator.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000333">::[]</a></li>
+
+ <li><a href="#M000335">::has_validator?</a></li>
+
+ <li><a href="#M000332">::load_validators</a></li>
+
+ <li><a href="#M000337">::load_validators?</a></li>
+
+ <li><a href="#M000334">::method_missing</a></li>
+
+ <li><a href="#M000338">::validate</a></li>
+
+ <li><a href="#M000336">::validator_class</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="module">MCollective::Validator</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000333"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">[]</span><span
+ class="method-args">(klass)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns and instance of the Plugin class from which objects can be created.
+Valid plugin names are
+</p>
+<pre>
+ :valplugin
+ "valplugin"
+ "ValpluginValidator"
+</pre>
+
+
+
+ <div class="method-source-code"
+ id="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 18</span>
+18: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">klass</span>)
+19: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Symbol</span>)
+20: <span class="ruby-identifier">klass</span> = <span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">klass</span>)
+21: <span class="ruby-keyword kw">elsif</span> <span class="ruby-operator">!</span>(<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/.*Validator$/</span>))
+22: <span class="ruby-identifier">klass</span> = <span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">klass</span>)
+23: <span class="ruby-keyword kw">end</span>
+24:
+25: <span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">klass</span>)
+26: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-validator--method" class="method-detail ">
+ <a name="M000335"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_validator?</span><span
+ class="method-args">(validator)</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="has-validator--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 37</span>
+37: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_validator?</span>(<span class="ruby-identifier">validator</span>)
+38: <span class="ruby-identifier">const_defined?</span>(<span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">validator</span>))
+39: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="load-validators-method" class="method-detail ">
+ <a name="M000332"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_validators</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Loads the validator plugins. Validators will only be loaded every 5 minutes
+</p>
+
+
+
+ <div class="method-source-code"
+ id="load-validators-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 6</span>
+ 6: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_validators</span>
+ 7: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">load_validators?</span>
+ 8: <span class="ruby-ivar">@last_load</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>
+ 9: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find_and_load</span>(<span class="ruby-value str">"validator"</span>)
+10: <span class="ruby-keyword kw">end</span>
+11: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="load-validators--method" class="method-detail ">
+ <a name="M000337"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">load_validators?</span><span
+ class="method-args">()</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="load-validators--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 45</span>
+45: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_validators?</span>
+46: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@last_load</span>.<span class="ruby-identifier">nil?</span>
+47:
+48: (<span class="ruby-ivar">@last_load</span> <span class="ruby-operator">-</span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>) <span class="ruby-operator">></span> <span class="ruby-value">300</span>
+49: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="method-missing-method" class="method-detail ">
+ <a name="M000334"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">method_missing</span><span
+ class="method-args">(method, *args, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Allows validation plugins to be called like module methods : <a
+href="Validator.html#M000338">Validator.validate()</a>
+</p>
+
+
+
+ <div class="method-source-code"
+ id="method-missing-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 29</span>
+29: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+30: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">has_validator?</span>(<span class="ruby-identifier">method</span>)
+31: <span class="ruby-identifier">validator</span> = <span class="ruby-constant">Validator</span>[<span class="ruby-identifier">method</span>].<span class="ruby-identifier">validate</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+32: <span class="ruby-keyword kw">else</span>
+33: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ValidatorError</span>, <span class="ruby-node">"Unknown validator: '#{method}'."</span>
+34: <span class="ruby-keyword kw">end</span>
+35: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validate-method" class="method-detail ">
+ <a name="M000338"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validate</span><span
+ class="method-args">(validator, validation)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Generic validate method that will call the correct validator plugin based
+on the type of the validation parameter
+</p>
+
+
+
+ <div class="method-source-code"
+ id="validate-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 53</span>
+53: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">validate</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
+54: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">load_validators</span>
+55:
+56: <span class="ruby-keyword kw">begin</span>
+57: <span class="ruby-keyword kw">if</span> [<span class="ruby-identifier">:integer</span>, <span class="ruby-identifier">:boolean</span>, <span class="ruby-identifier">:float</span>, <span class="ruby-identifier">:number</span>, <span class="ruby-identifier">:string</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">validation</span>)
+58: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">typecheck</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
+59:
+60: <span class="ruby-keyword kw">else</span>
+61: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">validation</span>
+62: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Regexp</span>,<span class="ruby-constant">String</span>
+63: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">regex</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
+64:
+65: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Symbol</span>
+66: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">validation</span>, <span class="ruby-identifier">validator</span>)
+67:
+68: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Array</span>
+69: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">array</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
+70:
+71: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Class</span>
+72: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">typecheck</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
+73: <span class="ruby-keyword kw">end</span>
+74: <span class="ruby-keyword kw">end</span>
+75: <span class="ruby-keyword kw">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+76: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ValidatorError</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>
+77: <span class="ruby-keyword kw">end</span>
+78: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="validator-class-method" class="method-detail ">
+ <a name="M000336"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">validator_class</span><span
+ class="method-args">(validator)</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="validator-class-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 41</span>
+41: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">validator</span>)
+42: <span class="ruby-node">"#{validator.to_s.capitalize}Validator"</span>
+43: <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>
+
--- /dev/null
+<?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::ValidatorError</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/exception_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.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">RuntimeError</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- 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::ValidatorError</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </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>
+
--- /dev/null
+<?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::WindowsDaemon</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/windows_daemon_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/windows_daemon.rb">lib/mcollective/windows_daemon.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">Win32::Daemon</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="#M000350">::daemonize_runner</a></li>
+
+ <li><a href="#M000351">#service_main</a></li>
+
+ <li><a href="#M000352">#service_stop</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::WindowsDaemon</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="daemonize-runner-method" class="method-detail ">
+ <a name="M000350"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">daemonize_runner</span><span
+ class="method-args">(pid=nil)</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="daemonize-runner-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/windows_daemon.rb, line 5</span>
+ 5: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">daemonize_runner</span>(<span class="ruby-identifier">pid</span>=<span class="ruby-keyword kw">nil</span>)
+ 6: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Writing pid files are not supported on the Windows Platform"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span>
+ 7: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"The Windows Daemonizer should only be used on the Windows Platform"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
+ 8:
+ 9: <span class="ruby-constant">WindowsDaemon</span>.<span class="ruby-identifier">mainloop</span>
+10: <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="service-main-method" class="method-detail ">
+ <a name="M000351"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">service_main</span><span
+ class="method-args">()</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="service-main-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/windows_daemon.rb, line 12</span>
+12: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">service_main</span>
+13: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Starting Windows Service Daemon"</span>)
+14:
+15: <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">running?</span>
+16: <span class="ruby-constant">Runner</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">nil</span>).<span class="ruby-identifier">run</span>
+17: <span class="ruby-keyword kw">end</span>
+18: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="service-stop-method" class="method-detail ">
+ <a name="M000352"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">service_stop</span><span
+ class="method-args">()</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="service-stop-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/windows_daemon.rb, line 20</span>
+20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">service_stop</span>
+21: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-value str">"Windows service stopping"</span>)
+22: <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>
+
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>
- <title>File: install.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>install.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>install.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
- <div id="requires-list">
- <h3 class="section-bar">Required files</h3>
-
- <div class="name-list">
- rbconfig
- find
- fileutils
- tempfile
- optparse
- ostruct
- rdoc/rdoc
- </div>
- </div>
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000007">build_rdoc</a>
- <a href="#M000002">check_prereqs</a>
- <a href="#M000004">do_bins</a>
- <a href="#M000003">do_configs</a>
- <a href="#M000005">do_libs</a>
- <a href="#M000001">glob</a>
- <a href="#M000008">install_binfile</a>
- <a href="#M000006">prepare_installation</a>
- </div>
- </div>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- </div>
+ <title>Class: Object</title>
+ <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
- <!-- if includes -->
- <div id="includes">
- <h3 class="section-bar">Included Modules</h3>
+ <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>
- <div id="includes-list">
- <span class="include-name">FileUtils</span>
- </div>
- </div>
-
- <div id="section">
-
-
- <div id="constants-list">
- <h3 class="section-bar">Constants</h3>
-
- <div class="name-list">
- <table summary="Constants">
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">PREREQS</td>
- <td>=</td>
- <td class="context-item-value">%w{rubygems stomp}</td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">InstallOptions</td>
- <td>=</td>
- <td class="context-item-value">OpenStruct.new</td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000007" class="method-detail">
- <a name="M000007"></a>
-
- <div class="method-heading">
- <a href="#M000007" class="method-signature">
- <span class="method-name">build_rdoc</span><span class="method-args">(files)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+</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>
+
+ </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="#M000520">#build_rdoc</a></li>
+
+ <li><a href="#M000515">#check_prereqs</a></li>
+
+ <li><a href="#M000517">#do_bins</a></li>
+
+ <li><a href="#M000516">#do_configs</a></li>
+
+ <li><a href="#M000518">#do_libs</a></li>
+
+ <li><a href="#M000514">#glob</a></li>
+
+ <li><a href="#M000521">#install_binfile</a></li>
+
+ <li><a href="#M000519">#prepare_installation</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">Object</h1>
+
+ <div id="description">
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="build-rdoc-method" class="method-detail ">
+ <a name="M000520"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">build_rdoc</span><span
+ class="method-args">(files)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Build the rdoc documentation.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000007-source">
+
+
+
+ <div class="method-source-code"
+ id="build-rdoc-source">
<pre>
- <span class="ruby-comment cmt"># File install.rb, line 246</span>
-246: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">build_rdoc</span>(<span class="ruby-identifier">files</span>)
-247: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">$haverdoc</span>
-248: <span class="ruby-keyword kw">begin</span>
-249: <span class="ruby-identifier">r</span> = <span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">RDoc</span>.<span class="ruby-identifier">new</span>
-250: <span class="ruby-identifier">r</span>.<span class="ruby-identifier">document</span>([<span class="ruby-value str">"--main"</span>, <span class="ruby-value str">"MCollective"</span>, <span class="ruby-value str">"--line-numbers"</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">files</span>)
-251: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">RDocError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-252: <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>
-253: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-254: <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Couldn't build RDoc documentation\n#{e.message}"</span>
-255: <span class="ruby-keyword kw">end</span>
-256: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000002" class="method-detail">
- <a name="M000002"></a>
-
- <div class="method-heading">
- <a href="#M000002" class="method-signature">
- <span class="method-name">check_prereqs</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000002-source">
+ <span class="ruby-comment cmt"># File install.rb, line 248</span>
+248: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">build_rdoc</span>(<span class="ruby-identifier">files</span>)
+249: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">$haverdoc</span>
+250: <span class="ruby-keyword kw">begin</span>
+251: <span class="ruby-identifier">r</span> = <span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">RDoc</span>.<span class="ruby-identifier">new</span>
+252: <span class="ruby-identifier">r</span>.<span class="ruby-identifier">document</span>([<span class="ruby-value str">"--main"</span>, <span class="ruby-value str">"MCollective"</span>, <span class="ruby-value str">"--line-numbers"</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">files</span>)
+253: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">RDocError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+254: <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>
+255: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+256: <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Couldn't build RDoc documentation\n#{e.message}"</span>
+257: <span class="ruby-keyword kw">end</span>
+258: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="check-prereqs-method" class="method-detail ">
+ <a name="M000515"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">check_prereqs</span><span
+ class="method-args">()</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="check-prereqs-source">
<pre>
<span class="ruby-comment cmt"># File install.rb, line 65</span>
65: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check_prereqs</span>
71: <span class="ruby-identifier">exit</span>(<span class="ruby-value">-1</span>)
72: <span class="ruby-keyword kw">end</span>
73: <span class="ruby-keyword kw">end</span>
-74: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000004" class="method-detail">
- <a name="M000004"></a>
-
- <div class="method-heading">
- <a href="#M000004" class="method-signature">
- <span class="method-name">do_bins</span><span class="method-args">(bins, target, strip = 's?bin/')</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000004-source">
+74: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="do-bins-method" class="method-detail ">
+ <a name="M000517"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">do_bins</span><span
+ class="method-args">(bins, target, strip = 's?bin/')</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="do-bins-source">
<pre>
<span class="ruby-comment cmt"># File install.rb, line 86</span>
86: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">do_bins</span>(<span class="ruby-identifier">bins</span>, <span class="ruby-identifier">target</span>, <span class="ruby-identifier">strip</span> = <span class="ruby-value str">'s?bin/'</span>)
89: <span class="ruby-identifier">obf</span> = <span class="ruby-identifier">bf</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-node">/#{strip}/</span>, <span class="ruby-value str">''</span>)
90: <span class="ruby-identifier">install_binfile</span>(<span class="ruby-identifier">bf</span>, <span class="ruby-identifier">obf</span>, <span class="ruby-identifier">target</span>)
91: <span class="ruby-keyword kw">end</span>
-92: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000003" class="method-detail">
- <a name="M000003"></a>
-
- <div class="method-heading">
- <a href="#M000003" class="method-signature">
- <span class="method-name">do_configs</span><span class="method-args">(configs, target, strip = 'etc/')</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000003-source">
+92: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="do-configs-method" class="method-detail ">
+ <a name="M000516"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">do_configs</span><span
+ class="method-args">(configs, target, strip = 'etc/')</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="do-configs-source">
<pre>
<span class="ruby-comment cmt"># File install.rb, line 76</span>
76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">do_configs</span>(<span class="ruby-identifier">configs</span>, <span class="ruby-identifier">target</span>, <span class="ruby-identifier">strip</span> = <span class="ruby-value str">'etc/'</span>)
81: <span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">oc</span>, {<span class="ruby-identifier">:mode</span> =<span class="ruby-operator">></span> <span class="ruby-value">0755</span>, <span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>})
82: <span class="ruby-identifier">install</span>(<span class="ruby-identifier">cf</span>, <span class="ruby-identifier">ocf</span>, {<span class="ruby-identifier">:mode</span> =<span class="ruby-operator">></span> <span class="ruby-value">0644</span>, <span class="ruby-identifier">:preserve</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>})
83: <span class="ruby-keyword kw">end</span>
-84: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000005" class="method-detail">
- <a name="M000005"></a>
-
- <div class="method-heading">
- <a href="#M000005" class="method-signature">
- <span class="method-name">do_libs</span><span class="method-args">(libs, target, strip = 'lib/')</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000005-source">
+84: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="do-libs-method" class="method-detail ">
+ <a name="M000518"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">do_libs</span><span
+ class="method-args">(libs, target, strip = 'lib/')</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="do-libs-source">
<pre>
<span class="ruby-comment cmt"># File install.rb, line 94</span>
94: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">do_libs</span>(<span class="ruby-identifier">libs</span>, <span class="ruby-identifier">target</span>, <span class="ruby-identifier">strip</span> = <span class="ruby-value str">'lib/'</span>)
102: <span class="ruby-identifier">install</span>(<span class="ruby-identifier">lf</span>, <span class="ruby-identifier">olf</span>, {<span class="ruby-identifier">:mode</span> =<span class="ruby-operator">></span> <span class="ruby-value">0644</span>, <span class="ruby-identifier">:preserve</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>})
103: <span class="ruby-keyword kw">end</span>
104: <span class="ruby-keyword kw">end</span>
-105: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000001" class="method-detail">
- <a name="M000001"></a>
-
- <div class="method-heading">
- <a href="#M000001" class="method-signature">
- <span class="method-name">glob</span><span class="method-args">(list)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000001-source">
+105: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="glob-method" class="method-detail ">
+ <a name="M000514"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">glob</span><span
+ class="method-args">(list)</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="glob-source">
<pre>
<span class="ruby-comment cmt"># File install.rb, line 57</span>
57: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">glob</span>(<span class="ruby-identifier">list</span>)
60: <span class="ruby-identifier">g</span>.<span class="ruby-identifier">compact!</span>
61: <span class="ruby-identifier">g</span>.<span class="ruby-identifier">uniq!</span>
62: <span class="ruby-identifier">g</span>
-63: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000008" class="method-detail">
- <a name="M000008"></a>
-
- <div class="method-heading">
- <a href="#M000008" class="method-signature">
- <span class="method-name">install_binfile</span><span class="method-args">(from, op_file, target)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+63: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="install-binfile-method" class="method-detail ">
+ <a name="M000521"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">install_binfile</span><span
+ class="method-args">(from, op_file, target)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Install file(s) from ./bin to RbConfig::CONFIG[‘bindir’]. Patch
it on the way to insert a #! line; on a Unix install, the command is named
as expected
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000008-source">
+
+
+
+ <div class="method-source-code"
+ id="install-binfile-source">
<pre>
- <span class="ruby-comment cmt"># File install.rb, line 261</span>
-261: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">install_binfile</span>(<span class="ruby-identifier">from</span>, <span class="ruby-identifier">op_file</span>, <span class="ruby-identifier">target</span>)
-262: <span class="ruby-identifier">tmp_file</span> = <span class="ruby-constant">Tempfile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'mcollective-binfile'</span>)
-263:
-264: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">ruby</span>
-265: <span class="ruby-identifier">ruby</span> = <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">ruby</span>
-266: <span class="ruby-keyword kw">else</span>
-267: <span class="ruby-identifier">ruby</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">RbConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">CONFIG</span>[<span class="ruby-value str">'bindir'</span>], <span class="ruby-constant">RbConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">CONFIG</span>[<span class="ruby-value str">'ruby_install_name'</span>])
-268: <span class="ruby-keyword kw">end</span>
-269:
-270: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">from</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ip</span><span class="ruby-operator">|</span>
-271: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">tmp_file</span>.<span class="ruby-identifier">path</span>, <span class="ruby-value str">"w"</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">op</span><span class="ruby-operator">|</span>
-272: <span class="ruby-identifier">op</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"#!#{ruby}"</span>
-273: <span class="ruby-identifier">contents</span> = <span class="ruby-identifier">ip</span>.<span class="ruby-identifier">readlines</span>
-274: <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">shift</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^#!/</span>
-275: <span class="ruby-identifier">op</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">join</span>
-276: <span class="ruby-keyword kw">end</span>
-277: <span class="ruby-keyword kw">end</span>
-278:
-279: <span class="ruby-identifier">install</span>(<span class="ruby-identifier">tmp_file</span>.<span class="ruby-identifier">path</span>, <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">target</span>, <span class="ruby-identifier">op_file</span>), <span class="ruby-identifier">:mode</span> =<span class="ruby-operator">></span> <span class="ruby-value">0755</span>, <span class="ruby-identifier">:preserve</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>)
-280: <span class="ruby-identifier">tmp_file</span>.<span class="ruby-identifier">unlink</span>
-281: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000006" class="method-detail">
- <a name="M000006"></a>
-
- <div class="method-heading">
- <a href="#M000006" class="method-signature">
- <span class="method-name">prepare_installation</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+ <span class="ruby-comment cmt"># File install.rb, line 263</span>
+263: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">install_binfile</span>(<span class="ruby-identifier">from</span>, <span class="ruby-identifier">op_file</span>, <span class="ruby-identifier">target</span>)
+264: <span class="ruby-identifier">tmp_file</span> = <span class="ruby-constant">Tempfile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'mcollective-binfile'</span>)
+265:
+266: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">ruby</span>
+267: <span class="ruby-identifier">ruby</span> = <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">ruby</span>
+268: <span class="ruby-keyword kw">else</span>
+269: <span class="ruby-identifier">ruby</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">RbConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">CONFIG</span>[<span class="ruby-value str">'bindir'</span>], <span class="ruby-constant">RbConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">CONFIG</span>[<span class="ruby-value str">'ruby_install_name'</span>])
+270: <span class="ruby-keyword kw">end</span>
+271:
+272: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">from</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ip</span><span class="ruby-operator">|</span>
+273: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">tmp_file</span>.<span class="ruby-identifier">path</span>, <span class="ruby-value str">"w"</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">op</span><span class="ruby-operator">|</span>
+274: <span class="ruby-identifier">op</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"#!#{ruby}"</span>
+275: <span class="ruby-identifier">contents</span> = <span class="ruby-identifier">ip</span>.<span class="ruby-identifier">readlines</span>
+276: <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">shift</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^#!/</span>
+277: <span class="ruby-identifier">op</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">join</span>
+278: <span class="ruby-keyword kw">end</span>
+279: <span class="ruby-keyword kw">end</span>
+280:
+281: <span class="ruby-identifier">install</span>(<span class="ruby-identifier">tmp_file</span>.<span class="ruby-identifier">path</span>, <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">target</span>, <span class="ruby-identifier">op_file</span>), <span class="ruby-identifier">:mode</span> =<span class="ruby-operator">></span> <span class="ruby-value">0755</span>, <span class="ruby-identifier">:preserve</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>)
+282: <span class="ruby-identifier">tmp_file</span>.<span class="ruby-identifier">unlink</span>
+283: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="prepare-installation-method" class="method-detail ">
+ <a name="M000519"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">prepare_installation</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Prepare the file installation.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000006-source">
+
+
+
+ <div class="method-source-code"
+ id="prepare-installation-source">
<pre>
<span class="ruby-comment cmt"># File install.rb, line 110</span>
110: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prepare_installation</span>
223: <span class="ruby-identifier">destdir</span> = <span class="ruby-value str">''</span>
224: <span class="ruby-keyword kw">end</span>
225:
-226: <span class="ruby-identifier">configdir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">destdir</span>, <span class="ruby-identifier">configdir</span>)
-227: <span class="ruby-identifier">bindir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">destdir</span>, <span class="ruby-identifier">bindir</span>)
-228: <span class="ruby-identifier">sitelibdir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">destdir</span>, <span class="ruby-identifier">sitelibdir</span>)
-229:
-230: <span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">configdir</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">configs</span>
-231: <span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">bindir</span>)
-232: <span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">sbindir</span>)
-233: <span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">sitelibdir</span>)
-234: <span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">plugindir</span>)
-235:
-236: <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">sitelibdir</span> = <span class="ruby-identifier">sitelibdir</span>
-237: <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">configdir</span> = <span class="ruby-identifier">configdir</span>
-238: <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">bindir</span> = <span class="ruby-identifier">bindir</span>
-239: <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">sbindir</span> = <span class="ruby-identifier">sbindir</span>
-240: <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">plugindir</span> = <span class="ruby-identifier">plugindir</span>
-241: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
+226: <span class="ruby-identifier">configdir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">destdir</span>, <span class="ruby-identifier">configdir</span>)
+227: <span class="ruby-identifier">bindir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">destdir</span>, <span class="ruby-identifier">bindir</span>)
+228: <span class="ruby-identifier">sbindir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">destdir</span>, <span class="ruby-identifier">sbindir</span>)
+229: <span class="ruby-identifier">sitelibdir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">destdir</span>, <span class="ruby-identifier">sitelibdir</span>)
+230: <span class="ruby-identifier">plugindir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">destdir</span>, <span class="ruby-identifier">plugindir</span>)
+231:
+232: <span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">configdir</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">configs</span>
+233: <span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">bindir</span>)
+234: <span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">sbindir</span>)
+235: <span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">sitelibdir</span>)
+236: <span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">plugindir</span>)
+237:
+238: <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">sitelibdir</span> = <span class="ruby-identifier">sitelibdir</span>
+239: <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">configdir</span> = <span class="ruby-identifier">configdir</span>
+240: <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">bindir</span> = <span class="ruby-identifier">bindir</span>
+241: <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">sbindir</span> = <span class="ruby-identifier">sbindir</span>
+242: <span class="ruby-constant">InstallOptions</span>.<span class="ruby-identifier">plugindir</span> = <span class="ruby-identifier">plugindir</span>
+243: <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>
\ No newline at end of file
+</html>
+
--- /dev/null
+<?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>File: README [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+The Marionette Collective
+</p>
+<h6>===================</h6>
+<p>
+The Marionette Collective aka. mcollective is a framework to build server
+orchestration or parallel job execution systems.
+</p>
+<p>
+For full information, wikis, ticketing and downloads please see <a
+href="http://marionette-collective.org/">marionette-collective.org/</a>
+</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>
+
--- /dev/null
+<?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>File: Rakefile [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+RAKE_ROOT = File.expand_path(File.dirname(<em>FILE</em>))
+</p>
+<p>
+# Allow override of RELEASE using BUILD_NUMBER ENV[“RELEASE”] =
+ENV[“BUILD_NUMBER“] if ENV[“BUILD_NUMBER“]
+</p>
+<p>
+begin
+</p>
+<pre>
+ load File.join(RAKE_ROOT, 'ext', 'packaging.rake')
+</pre>
+<p>
+rescue LoadError end
+</p>
+<p>
+def announce(msg=’’)
+</p>
+<pre>
+ STDERR.puts "================"
+ STDERR.puts msg
+ STDERR.puts "================"
+</pre>
+<p>
+end
+</p>
+<p>
+def safe_system *args
+</p>
+<pre>
+ raise RuntimeError, "Failed: #{args.join(' ')}" unless system(*args)
+</pre>
+<p>
+end
+</p>
+<p>
+def load_tools
+</p>
+<pre>
+ unless File.directory?(File.join(RAKE_ROOT, 'ext', 'packaging'))
+ Rake::Task["package:bootstrap"].invoke
+ begin
+ load File.join(RAKE_ROOT, 'ext', 'packaging.rake')
+ rescue LoadError
+ STDERR.puts "Could not load packaging tools. exiting"
+ exit 1
+ end
+ end
+</pre>
+<p>
+end
+</p>
+<p>
+def move_artifacts
+</p>
+<pre>
+ mv("pkg", "build")
+</pre>
+<p>
+end
+</p>
+<p>
+desc “Cleanup” task :clean do
+</p>
+<pre>
+ rm_rf "build"
+ rm_rf "doc"
+</pre>
+<p>
+end
+</p>
+<p>
+desc “Create the .debs” task :deb => :clean do
+</p>
+<pre>
+ load_tools
+ announce("Building debian packages for #{@build.project}-#{@build.version}-#{@build.release}")
+ Rake::Task["package:deb"].invoke
+
+ if ENV['SIGNED'] == '1'
+ deb_flag = "-k#{ENV['SIGNWITH']}" if ENV['SIGNWITH']
+ safe_system %{/usr/bin/debsign #{deb_flag} pkg/deb/*.changes}
+ end
+ move_artifacts
+</pre>
+<p>
+end
+</p>
+<p>
+desc “Build documentation” task :doc => :clean do
+</p>
+<pre>
+ load_tools
+ Rake::Task["package:doc"].invoke
+</pre>
+<p>
+end
+</p>
+<p>
+desc “Build a gem” task :gem => :clean do
+</p>
+<pre>
+ load_tools
+ Rake::Task["gem"].reenable
+ Rake::Task["package:gem"].invoke
+</pre>
+<p>
+end
+</p>
+<p>
+desc “Create a tarball for this release” task :package =>
+:clean do
+</p>
+<pre>
+ load_tools
+ announce "Creating #{@build.project}-#{@build.version}.tar.gz"
+ Rake::Task["package:tar"].invoke
+ move_artifacts
+</pre>
+<p>
+end
+</p>
+<p>
+desc “Creates a RPM” task :rpm => :clean do
+</p>
+<pre>
+ load_tools
+ announce("Building RPM for #{@build.project}-#{@build.version}-#{@build.release}")
+ Rake::Task["package:rpm"].invoke
+ Rake::Task["package:srpm"].invoke
+ if ENV['SIGNED'] == '1'
+ safe_system %{/usr/bin/rpm --sign pkg/**/*.rpm}
+ end
+ move_artifacts
+</pre>
+<p>
+end
+</p>
+<p>
+desc “Run spec tests” task :test do
+</p>
+<pre>
+ sh "cd spec && rake"
+</pre>
+<p>
+end
+</p>
+<p>
+desc “Creates the website as a tarball” task :website => :clean
+do
+</p>
+<pre>
+ FileUtils.mkdir_p("build/marionette-collective.org/html")
+
+ Dir.chdir("website") do
+ safe_system("jekyll ../build/marionette-collective.org/html")
+ end
+
+ unless File.exist?("build/marionette-collective.org/html/index.html")
+ raise "Failed to build website"
+ end
+
+ Dir.chdir("build") do
+ safe_system("tar -cvzf marionette-collective-org-#{Time.now.to_i}.tgz marionette-collective.org")
+ end
+</pre>
+<p>
+end
+</p>
+<p>
+desc “Update the website error code reference based on current
+local” task :update_msgweb do
+</p>
+<pre>
+ mcollective_dir = File.join(File.dirname(__FILE__))
+
+ $:.insert(0, File.join(mcollective_dir, "lib"))
+
+ require 'mcollective'
+
+ messages = YAML.load_file(File.join(mcollective_dir, "lib", "mcollective", "locales", "en.yml"))
+
+ webdir = File.join(mcollective_dir, "website", "messages")
+
+ I18n.load_path = Dir[File.join(mcollective_dir, "lib", "mcollective", "locales", "*.yml")]
+ I18n.locale = :en
+
+ messages["en"].keys.each do |msg_code|
+ md_file = File.join(webdir, "#{msg_code}.md")
+
+ puts "....writing %s" % md_file
+
+ File.open(md_file, "w") do |md|
+ md.puts "---"
+ md.puts "layout: default"
+ md.puts "title: Message detail for %s" % msg_code
+ md.puts "toc: false"
+ md.puts "---"
+ md.puts
+ md.puts "Example Message"
+ md.puts "---------------"
+ md.puts
+ md.puts " %s" % (MCollective::Util.t("%s.example" % msg_code, :raise => true) rescue MCollective::Util.t("%s.pattern" % msg_code))
+ md.puts
+ md.puts "Additional Information"
+ md.puts "----------------------"
+ md.puts
+ md.puts MCollective::Util.t("%s.expanded" % msg_code, :raise => true)
+ end
+ end
+</pre>
+<p>
+end
+</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>
+
--- /dev/null
+<?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: String</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/monkey_patches_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/monkey_patches.rb">lib/mcollective/monkey_patches.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="#M000201">#bytes</a></li>
+
+ <li><a href="#M000198">#start_with?</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">String</h1>
+
+ <div id="description">
+ <p>
+start_with? was introduced in 1.8.7, we need to support 1.8.5 and 1.8.6
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="bytes-method" class="method-detail ">
+ <a name="M000201"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">bytes</span><span
+ class="method-args">(&block)</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="bytes-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 63</span>
+63: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">bytes</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+64: <span class="ruby-comment cmt"># This should not be necessary, really ...</span>
+65: <span class="ruby-identifier">require</span> <span class="ruby-value str">'enumerator'</span>
+66: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">to_enum</span>(<span class="ruby-identifier">:each_byte</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">block_given?</span>
+67: <span class="ruby-identifier">each_byte</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+68: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="start-with--method" class="method-detail ">
+ <a name="M000198"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">start_with?</span><span
+ class="method-args">(str)</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="start-with--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 4</span>
+4: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start_with?</span>(<span class="ruby-identifier">str</span>)
+5: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-value">0</span> <span class="ruby-operator">..</span> (<span class="ruby-identifier">str</span>.<span class="ruby-identifier">length</span><span class="ruby-operator">-</span><span class="ruby-value">1</span>)] <span class="ruby-operator">==</span> <span class="ruby-identifier">str</span>
+6: <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>
+
--- /dev/null
+<?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: Symbol</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/monkey_patches_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/monkey_patches.rb">lib/mcollective/monkey_patches.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="#M000199">#<=></a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ <div id="includes-section" class="section">
+ <h3 class="section-header">Included Modules</h3>
+ <ul class="link-list">
+
+
+ <li><span class="include">Comparable</span></li>
+
+
+ </ul>
+ </div>
+
+ </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">Symbol</h1>
+
+ <div id="description">
+ <p>
+Make arrays of Symbols sortable
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="--method" class="method-detail ">
+ <a name="M000199"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name"><=></span><span
+ class="method-args">(other)</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="--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 13</span>
+13: <span class="ruby-keyword kw">def</span> <span class="ruby-operator"><=></span>(<span class="ruby-identifier">other</span>)
+14: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">to_s</span>
+15: <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>
+
--- /dev/null
+<?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>File: mc-call-agent [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>mcollective</li>
+
+ <li>pp</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: mco [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>mcollective</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: mcollectived [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>mcollective</li>
+
+ <li>getoptlong</li>
+
+ <li>mcollective/windows_daemon</li>
+
+ <li>mcollective/unix_daemon</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: Array</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">Array</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../files/lib/mcollective/monkey_patches_rb.html">
- lib/mcollective/monkey_patches.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-a method # that walks an array in groups, pass a block to call the block on
-each sub array
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000013">in_groups_of</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000013" class="method-detail">
- <a name="M000013"></a>
-
- <div class="method-heading">
- <a href="#M000013" class="method-signature">
- <span class="method-name">in_groups_of</span><span class="method-args">(chunk_size, padded_with=nil) {|a| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000013-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 29</span>
-29: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">in_groups_of</span>(<span class="ruby-identifier">chunk_size</span>, <span class="ruby-identifier">padded_with</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-30: <span class="ruby-identifier">arr</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">clone</span>
-31:
-32: <span class="ruby-comment cmt"># how many to add</span>
-33: <span class="ruby-identifier">padding</span> = <span class="ruby-identifier">chunk_size</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">arr</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">chunk_size</span>)
-34:
-35: <span class="ruby-comment cmt"># pad at the end</span>
-36: <span class="ruby-identifier">arr</span>.<span class="ruby-identifier">concat</span>([<span class="ruby-identifier">padded_with</span>] <span class="ruby-operator">*</span> <span class="ruby-identifier">padding</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">padding</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">chunk_size</span>
-37:
-38: <span class="ruby-comment cmt"># how many chunks we'll make</span>
-39: <span class="ruby-identifier">count</span> = <span class="ruby-identifier">arr</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">chunk_size</span>
-40:
-41: <span class="ruby-comment cmt"># make that many arrays</span>
-42: <span class="ruby-identifier">result</span> = []
-43: <span class="ruby-identifier">count</span>.<span class="ruby-identifier">times</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">arr</span>[<span class="ruby-identifier">s</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">chunk_size</span>, <span class="ruby-identifier">chunk_size</span>]}
-44:
-45: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-46: <span class="ruby-identifier">result</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">a</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
-47: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">arity</span>
-48: <span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span>
-49: <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">a</span>)
-50: <span class="ruby-keyword kw">when</span> <span class="ruby-value">2</span>
-51: <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">a</span>, (<span class="ruby-identifier">i</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>))
-52: <span class="ruby-keyword kw">else</span>
-53: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Expected 1 or 2 arguments, got #{block.arity}"</span>
-54: <span class="ruby-keyword kw">end</span>
-55: <span class="ruby-keyword kw">end</span>
-56: <span class="ruby-keyword kw">else</span>
-57: <span class="ruby-identifier">result</span>
-58: <span class="ruby-keyword kw">end</span>
-59: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: Dir</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">Dir</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../files/lib/mcollective/monkey_patches_rb.html">
- lib/mcollective/monkey_patches.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000011">mktmpdir</a>
- <a href="#M000012">tmpdir</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000011" class="method-detail">
- <a name="M000011"></a>
-
- <div class="method-heading">
- <a href="#M000011" class="method-signature">
- <span class="method-name">mktmpdir</span><span class="method-args">(prefix_suffix=nil, tmpdir=nil) {|path| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000011-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 72</span>
- 72: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">mktmpdir</span>(<span class="ruby-identifier">prefix_suffix</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">tmpdir</span>=<span class="ruby-keyword kw">nil</span>)
- 73: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">prefix_suffix</span>
- 74: <span class="ruby-keyword kw">when</span> <span class="ruby-keyword kw">nil</span>
- 75: <span class="ruby-identifier">prefix</span> = <span class="ruby-value str">"d"</span>
- 76: <span class="ruby-identifier">suffix</span> = <span class="ruby-value str">""</span>
- 77: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">String</span>
- 78: <span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">prefix_suffix</span>
- 79: <span class="ruby-identifier">suffix</span> = <span class="ruby-value str">""</span>
- 80: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Array</span>
- 81: <span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">prefix_suffix</span>[<span class="ruby-value">0</span>]
- 82: <span class="ruby-identifier">suffix</span> = <span class="ruby-identifier">prefix_suffix</span>[<span class="ruby-value">1</span>]
- 83: <span class="ruby-keyword kw">else</span>
- 84: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"unexpected prefix_suffix: #{prefix_suffix.inspect}"</span>
- 85: <span class="ruby-keyword kw">end</span>
- 86: <span class="ruby-identifier">tmpdir</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">tmpdir</span>
- 87: <span class="ruby-identifier">t</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">"%Y%m%d"</span>)
- 88: <span class="ruby-identifier">n</span> = <span class="ruby-keyword kw">nil</span>
- 89: <span class="ruby-keyword kw">begin</span>
- 90: <span class="ruby-identifier">path</span> = <span class="ruby-node">"#{tmpdir}/#{prefix}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"</span>
- 91: <span class="ruby-identifier">path</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"-#{n}"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">n</span>
- 92: <span class="ruby-identifier">path</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">suffix</span>
- 93: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span>(<span class="ruby-identifier">path</span>, <span class="ruby-value">0700</span>)
- 94: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EEXIST</span>
- 95: <span class="ruby-identifier">n</span> <span class="ruby-operator">||=</span> <span class="ruby-value">0</span>
- 96: <span class="ruby-identifier">n</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
- 97: <span class="ruby-keyword kw">retry</span>
- 98: <span class="ruby-keyword kw">end</span>
- 99:
-100: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-101: <span class="ruby-keyword kw">begin</span>
-102: <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">path</span>
-103: <span class="ruby-keyword kw">ensure</span>
-104: <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">remove_entry_secure</span> <span class="ruby-identifier">path</span>
-105: <span class="ruby-keyword kw">end</span>
-106: <span class="ruby-keyword kw">else</span>
-107: <span class="ruby-identifier">path</span>
-108: <span class="ruby-keyword kw">end</span>
-109: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000012" class="method-detail">
- <a name="M000012"></a>
-
- <div class="method-heading">
- <a href="#M000012" class="method-signature">
- <span class="method-name">tmpdir</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000012-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 111</span>
-111: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">tmpdir</span>
-112: <span class="ruby-identifier">tmp</span> = <span class="ruby-value str">'.'</span>
-113: <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">dir</span> <span class="ruby-keyword kw">in</span> [<span class="ruby-constant">ENV</span>[<span class="ruby-value str">'TMPDIR'</span>], <span class="ruby-constant">ENV</span>[<span class="ruby-value str">'TMP'</span>], <span class="ruby-constant">ENV</span>[<span class="ruby-value str">'TEMP'</span>], <span class="ruby-value str">'/tmp'</span>]
-114: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">dir</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">stat</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">stat</span>(<span class="ruby-identifier">dir</span>) <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">stat</span>.<span class="ruby-identifier">directory?</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">stat</span>.<span class="ruby-identifier">writable?</span>
-115: <span class="ruby-identifier">tmp</span> = <span class="ruby-identifier">dir</span>
-116: <span class="ruby-keyword kw">break</span>
-117: <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
-118: <span class="ruby-keyword kw">end</span>
-119: <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">tmp</span>)
-120: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../files/lib/mcollective_rb.html">
- lib/mcollective.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/application_rb.html">
- lib/mcollective/application.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/optionparser_rb.html">
- lib/mcollective/optionparser.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/pluginpackager_rb.html">
- lib/mcollective/pluginpackager.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/matcher/scanner_rb.html">
- lib/mcollective/matcher/scanner.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/matcher/parser_rb.html">
- lib/mcollective/matcher/parser.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/message_rb.html">
- lib/mcollective/message.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/matcher_rb.html">
- lib/mcollective/matcher.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/runner_rb.html">
- lib/mcollective/runner.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/pluginmanager_rb.html">
- lib/mcollective/pluginmanager.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/security_rb.html">
- lib/mcollective/security.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/connector_rb.html">
- lib/mcollective/connector.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/pluginpackager/standard_definition_rb.html">
- lib/mcollective/pluginpackager/standard_definition.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/pluginpackager/agent_definition_rb.html">
- lib/mcollective/pluginpackager/agent_definition.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/applications_rb.html">
- lib/mcollective/applications.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/logger_rb.html">
- lib/mcollective/logger.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/agents_rb.html">
- lib/mcollective/agents.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/config_rb.html">
- lib/mcollective/config.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/log_rb.html">
- lib/mcollective/log.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/agent_rb.html">
- lib/mcollective/agent.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/aggregate_rb.html">
- lib/mcollective/aggregate.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/discovery_rb.html">
- lib/mcollective/discovery.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/registration/base_rb.html">
- lib/mcollective/registration/base.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/registration_rb.html">
- lib/mcollective/registration.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/logger/console_logger_rb.html">
- lib/mcollective/logger/console_logger.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/logger/base_rb.html">
- lib/mcollective/logger/base.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/logger/syslog_logger_rb.html">
- lib/mcollective/logger/syslog_logger.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/logger/file_logger_rb.html">
- lib/mcollective/logger/file_logger.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/data/base_rb.html">
- lib/mcollective/data/base.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/data/result_rb.html">
- lib/mcollective/data/result.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/ssl_rb.html">
- lib/mcollective/ssl.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/runnerstats_rb.html">
- lib/mcollective/runnerstats.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/translatable_rb.html">
- lib/mcollective/translatable.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/generators/base_rb.html">
- lib/mcollective/generators/base.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/generators/data_generator_rb.html">
- lib/mcollective/generators/data_generator.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/generators/agent_generator_rb.html">
- lib/mcollective/generators/agent_generator.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/aggregate/base_rb.html">
- lib/mcollective/aggregate/base.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/aggregate/result/base_rb.html">
- lib/mcollective/aggregate/result/base.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/aggregate/result/collection_result_rb.html">
- lib/mcollective/aggregate/result/collection_result.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/aggregate/result/numeric_result_rb.html">
- lib/mcollective/aggregate/result/numeric_result.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/aggregate/result_rb.html">
- lib/mcollective/aggregate/result.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/facts/base_rb.html">
- lib/mcollective/facts/base.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/ddl/discoveryddl_rb.html">
- lib/mcollective/ddl/discoveryddl.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/ddl/agentddl_rb.html">
- lib/mcollective/ddl/agentddl.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/ddl/validatorddl_rb.html">
- lib/mcollective/ddl/validatorddl.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/ddl/base_rb.html">
- lib/mcollective/ddl/base.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/ddl/dataddl_rb.html">
- lib/mcollective/ddl/dataddl.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/util_rb.html">
- lib/mcollective/util.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/connector/base_rb.html">
- lib/mcollective/connector/base.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/rpc_rb.html">
- lib/mcollective/rpc.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/validator_rb.html">
- lib/mcollective/validator.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/cache_rb.html">
- lib/mcollective/cache.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/unix_daemon_rb.html">
- lib/mcollective/unix_daemon.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/windows_daemon_rb.html">
- lib/mcollective/windows_daemon.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/security/base_rb.html">
- lib/mcollective/security/base.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/shell_rb.html">
- lib/mcollective/shell.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/ddl_rb.html">
- lib/mcollective/ddl.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/rpc/actionrunner_rb.html">
- lib/mcollective/rpc/actionrunner.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/rpc/reply_rb.html">
- lib/mcollective/rpc/reply.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/rpc/progress_rb.html">
- lib/mcollective/rpc/progress.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/rpc/agent_rb.html">
- lib/mcollective/rpc/agent.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/rpc/request_rb.html">
- lib/mcollective/rpc/request.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/rpc/audit_rb.html">
- lib/mcollective/rpc/audit.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/rpc/stats_rb.html">
- lib/mcollective/rpc/stats.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/rpc/result_rb.html">
- lib/mcollective/rpc/result.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/rpc/client_rb.html">
- lib/mcollective/rpc/client.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/rpc/helpers_rb.html">
- lib/mcollective/rpc/helpers.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/facts_rb.html">
- lib/mcollective/facts.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/data_rb.html">
- lib/mcollective/data.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/client_rb.html">
- lib/mcollective/client.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- <a href="../files/lib/mcollective/generators_rb.html">
- lib/mcollective/generators.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <h2>The Marionette Collective</h2>
-<p>
-Framework to build and run Systems Administration agents running on a
-publish/subscribe middleware system. The system allows you to treat your
-network as the only true source of the state of your platform via discovery
-agents and allow you to run agents matching discovery criteria.
-</p>
-<p>
-For an overview of the idea behind this and what it enables please see:
-</p>
-<pre>
- http://www.devco.net/archives/2009/10/18/middleware_for_systems_administration.php
-</pre>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000015">version</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Module <a href="MCollective/Agent.html" class="link">MCollective::Agent</a><br />
-Module <a href="MCollective/Cache.html" class="link">MCollective::Cache</a><br />
-Module <a href="MCollective/Connector.html" class="link">MCollective::Connector</a><br />
-Module <a href="MCollective/DDL.html" class="link">MCollective::DDL</a><br />
-Module <a href="MCollective/Data.html" class="link">MCollective::Data</a><br />
-Module <a href="MCollective/Facts.html" class="link">MCollective::Facts</a><br />
-Module <a href="MCollective/Generators.html" class="link">MCollective::Generators</a><br />
-Module <a href="MCollective/Logger.html" class="link">MCollective::Logger</a><br />
-Module <a href="MCollective/Matcher.html" class="link">MCollective::Matcher</a><br />
-Module <a href="MCollective/PluginManager.html" class="link">MCollective::PluginManager</a><br />
-Module <a href="MCollective/PluginPackager.html" class="link">MCollective::PluginPackager</a><br />
-Module <a href="MCollective/RPC.html" class="link">MCollective::RPC</a><br />
-Module <a href="MCollective/Registration.html" class="link">MCollective::Registration</a><br />
-Module <a href="MCollective/Security.html" class="link">MCollective::Security</a><br />
-Module <a href="MCollective/Translatable.html" class="link">MCollective::Translatable</a><br />
-Module <a href="MCollective/Util.html" class="link">MCollective::Util</a><br />
-Module <a href="MCollective/Validator.html" class="link">MCollective::Validator</a><br />
-Class <a href="MCollective/Agents.html" class="link">MCollective::Agents</a><br />
-Class <a href="MCollective/Aggregate.html" class="link">MCollective::Aggregate</a><br />
-Class <a href="MCollective/Application.html" class="link">MCollective::Application</a><br />
-Class <a href="MCollective/Applications.html" class="link">MCollective::Applications</a><br />
-Class <a href="MCollective/Client.html" class="link">MCollective::Client</a><br />
-Class <a href="MCollective/CodedError.html" class="link">MCollective::CodedError</a><br />
-Class <a href="MCollective/Config.html" class="link">MCollective::Config</a><br />
-Class <a href="MCollective/DDLValidationError.html" class="link">MCollective::DDLValidationError</a><br />
-Class <a href="MCollective/Discovery.html" class="link">MCollective::Discovery</a><br />
-Class <a href="MCollective/InvalidRPCData.html" class="link">MCollective::InvalidRPCData</a><br />
-Class <a href="MCollective/Log.html" class="link">MCollective::Log</a><br />
-Class <a href="MCollective/Message.html" class="link">MCollective::Message</a><br />
-Class <a href="MCollective/MissingRPCData.html" class="link">MCollective::MissingRPCData</a><br />
-Class <a href="MCollective/MsgDoesNotMatchRequestID.html" class="link">MCollective::MsgDoesNotMatchRequestID</a><br />
-Class <a href="MCollective/MsgTTLExpired.html" class="link">MCollective::MsgTTLExpired</a><br />
-Class <a href="MCollective/NotTargettedAtUs.html" class="link">MCollective::NotTargettedAtUs</a><br />
-Class <a href="MCollective/Optionparser.html" class="link">MCollective::Optionparser</a><br />
-Class <a href="MCollective/RPCAborted.html" class="link">MCollective::RPCAborted</a><br />
-Class <a href="MCollective/RPCError.html" class="link">MCollective::RPCError</a><br />
-Class <a href="MCollective/Runner.html" class="link">MCollective::Runner</a><br />
-Class <a href="MCollective/RunnerStats.html" class="link">MCollective::RunnerStats</a><br />
-Class <a href="MCollective/SSL.html" class="link">MCollective::SSL</a><br />
-Class <a href="MCollective/SecurityValidationFailed.html" class="link">MCollective::SecurityValidationFailed</a><br />
-Class <a href="MCollective/Shell.html" class="link">MCollective::Shell</a><br />
-Class <a href="MCollective/UnixDaemon.html" class="link">MCollective::UnixDaemon</a><br />
-Class <a href="MCollective/UnknownRPCAction.html" class="link">MCollective::UnknownRPCAction</a><br />
-Class <a href="MCollective/UnknownRPCError.html" class="link">MCollective::UnknownRPCError</a><br />
-Class <a href="MCollective/ValidatorError.html" class="link">MCollective::ValidatorError</a><br />
-Class <a href="MCollective/WindowsDaemon.html" class="link">MCollective::WindowsDaemon</a><br />
-
- </div>
-
- <div id="constants-list">
- <h3 class="section-bar">Constants</h3>
-
- <div class="name-list">
- <table summary="Constants">
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">VERSION</td>
- <td>=</td>
- <td class="context-item-value">"@DEVELOPMENT_VERSION@"</td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000015" class="method-detail">
- <a name="M000015"></a>
-
- <div class="method-heading">
- <a href="#M000015" class="method-signature">
- <span class="method-name">version</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000015-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective.rb, line 65</span>
-65: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">version</span>
-66: <span class="ruby-constant">VERSION</span>
-67: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::Agent</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Agent</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/agent_rb.html">
- lib/mcollective/agent.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Agents</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Agents</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/agents_rb.html">
- lib/mcollective/agents.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A collection of agents, loads them, reloads them and dispatches messages to
-them. It uses the <a href="PluginManager.html">PluginManager</a> to store,
-load and manage instances of plugins.
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000487">activate_agent?</a>
- <a href="#M000491">agentlist</a>
- <a href="#M000486">class_for_agent</a>
- <a href="#M000483">clear!</a>
- <a href="#M000490">dispatch</a>
- <a href="#M000488">findagentfile</a>
- <a href="#M000489">include?</a>
- <a href="#M000485">loadagent</a>
- <a href="#M000484">loadagents</a>
- <a href="#M000482">new</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000491" class="method-detail">
- <a name="M000491"></a>
-
- <div class="method-heading">
- <a href="#M000491" class="method-signature">
- <span class="method-name">agentlist</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Get a list of agents that we have
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000491-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000491-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 145</span>
-145: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">agentlist</span>
-146: <span class="ruby-ivar">@@agents</span>.<span class="ruby-identifier">keys</span>
-147: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000482" class="method-detail">
- <a name="M000482"></a>
-
- <div class="method-heading">
- <a href="#M000482" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(agents = {})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000482-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000482-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 5</span>
- 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">agents</span> = {})
- 6: <span class="ruby-ivar">@config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
- 7: <span class="ruby-identifier">raise</span> (<span class="ruby-value str">"Configuration has not been loaded, can't load agents"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">configured</span>
- 8:
- 9: <span class="ruby-ivar">@@agents</span> = <span class="ruby-identifier">agents</span>
-10:
-11: <span class="ruby-identifier">loadagents</span>
-12: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000487" class="method-detail">
- <a name="M000487"></a>
-
- <div class="method-heading">
- <a href="#M000487" class="method-signature">
- <span class="method-name">activate_agent?</span><span class="method-args">(agent)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Checks if a plugin should be activated by calling activate? on it if it
-responds to that method else always activate it
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000487-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000487-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 85</span>
-85: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">activate_agent?</span>(<span class="ruby-identifier">agent</span>)
-86: <span class="ruby-identifier">klass</span> = <span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-value str">"MCollective"</span>).<span class="ruby-identifier">const_get</span>(<span class="ruby-value str">"Agent"</span>).<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">agent</span>.<span class="ruby-identifier">capitalize</span>)
-87:
-88: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"activate?"</span>)
-89: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">activate?</span>
-90: <span class="ruby-keyword kw">else</span>
-91: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"#{klass} does not have an activate? method, activating as default"</span>)
-92: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-93: <span class="ruby-keyword kw">end</span>
-94: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-95: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Agent activation check for #{agent} failed: #{e.class}: #{e}"</span>)
-96: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
-97: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000486" class="method-detail">
- <a name="M000486"></a>
-
- <div class="method-heading">
- <a href="#M000486" class="method-signature">
- <span class="method-name">class_for_agent</span><span class="method-args">(agent)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Builds a class name string given a <a href="Agent.html">Agent</a> name
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000486-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000486-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 78</span>
-78: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">class_for_agent</span>(<span class="ruby-identifier">agent</span>)
-79: <span class="ruby-node">"MCollective::Agent::#{agent.capitalize}"</span>
-80: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000483" class="method-detail">
- <a name="M000483"></a>
-
- <div class="method-heading">
- <a href="#M000483" class="method-signature">
- <span class="method-name">clear!</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Deletes all agents
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000483-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000483-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 15</span>
-15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">clear!</span>
-16: <span class="ruby-ivar">@@agents</span>.<span class="ruby-identifier">each_key</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">agent</span><span class="ruby-operator">|</span>
-17: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">delete</span> <span class="ruby-node">"#{agent}_agent"</span>
-18: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">unsubscribe</span>(<span class="ruby-constant">Util</span>.<span class="ruby-identifier">make_subscriptions</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:broadcast</span>))
-19: <span class="ruby-keyword kw">end</span>
-20:
-21: <span class="ruby-ivar">@@agents</span> = {}
-22: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000490" class="method-detail">
- <a name="M000490"></a>
-
- <div class="method-heading">
- <a href="#M000490" class="method-signature">
- <span class="method-name">dispatch</span><span class="method-args">(request, connection) {|replies| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Dispatches a message to an agent, accepts a block that will get run if
-there are any replies to process from the agent
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000490-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000490-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 118</span>
-118: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dispatch</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">connection</span>)
-119: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Dispatching a message to agent #{request.agent}"</span>)
-120:
-121: <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span>
-122: <span class="ruby-keyword kw">begin</span>
-123: <span class="ruby-identifier">agent</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-node">"#{request.agent}_agent"</span>]
-124:
-125: <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-identifier">timeout</span>(<span class="ruby-identifier">agent</span>.<span class="ruby-identifier">timeout</span>) <span class="ruby-keyword kw">do</span>
-126: <span class="ruby-identifier">replies</span> = <span class="ruby-identifier">agent</span>.<span class="ruby-identifier">handlemsg</span>(<span class="ruby-identifier">request</span>.<span class="ruby-identifier">payload</span>, <span class="ruby-identifier">connection</span>)
-127:
-128: <span class="ruby-comment cmt"># Agents can decide if they wish to reply or not,</span>
-129: <span class="ruby-comment cmt"># returning nil will mean nothing goes back to the</span>
-130: <span class="ruby-comment cmt"># requestor</span>
-131: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">replies</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
-132: <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">replies</span>)
-133: <span class="ruby-keyword kw">end</span>
-134: <span class="ruby-keyword kw">end</span>
-135: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-136: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Timeout while handling message for #{request.agent}"</span>)
-137: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-138: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Execution of #{request.agent} failed: #{e}"</span>)
-139: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n\t\t"</span>))
-140: <span class="ruby-keyword kw">end</span>
-141: <span class="ruby-keyword kw">end</span>
-142: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000488" class="method-detail">
- <a name="M000488"></a>
-
- <div class="method-heading">
- <a href="#M000488" class="method-signature">
- <span class="method-name">findagentfile</span><span class="method-args">(agentname)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-searches the libdirs for agents
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000488-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000488-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 100</span>
-100: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">findagentfile</span>(<span class="ruby-identifier">agentname</span>)
-101: <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">libdir</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">libdir</span><span class="ruby-operator">|</span>
-102: <span class="ruby-identifier">agentfile</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>([<span class="ruby-identifier">libdir</span>, <span class="ruby-value str">"mcollective"</span>, <span class="ruby-value str">"agent"</span>, <span class="ruby-node">"#{agentname}.rb"</span>])
-103: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">agentfile</span>)
-104: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Found #{agentname} at #{agentfile}"</span>)
-105: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">agentfile</span>
-106: <span class="ruby-keyword kw">end</span>
-107: <span class="ruby-keyword kw">end</span>
-108: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
-109: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000489" class="method-detail">
- <a name="M000489"></a>
-
- <div class="method-heading">
- <a href="#M000489" class="method-signature">
- <span class="method-name">include?</span><span class="method-args">(agentname)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Determines if we have an agent with a certain name
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000489-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000489-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 112</span>
-112: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">agentname</span>)
-113: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-node">"#{agentname}_agent"</span>)
-114: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000485" class="method-detail">
- <a name="M000485"></a>
-
- <div class="method-heading">
- <a href="#M000485" class="method-signature">
- <span class="method-name">loadagent</span><span class="method-args">(agentname)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Loads a specified agent from disk if available
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000485-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000485-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 42</span>
-42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">loadagent</span>(<span class="ruby-identifier">agentname</span>)
-43: <span class="ruby-identifier">agentfile</span> = <span class="ruby-identifier">findagentfile</span>(<span class="ruby-identifier">agentname</span>)
-44: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">agentfile</span>
-45: <span class="ruby-identifier">classname</span> = <span class="ruby-identifier">class_for_agent</span>(<span class="ruby-identifier">agentname</span>)
-46:
-47: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-node">"#{agentname}_agent"</span>)
-48:
-49: <span class="ruby-keyword kw">begin</span>
-50: <span class="ruby-identifier">single_instance</span> = [<span class="ruby-value str">"registration"</span>, <span class="ruby-value str">"discovery"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">agentname</span>)
-51:
-52: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-identifier">classname</span>)
-53:
-54: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">activate_agent?</span>(<span class="ruby-identifier">agentname</span>)
-55: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{agentname}_agent"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">classname</span>, <span class="ruby-identifier">:single_instance</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">single_instance</span>}
-56:
-57: <span class="ruby-comment cmt"># Attempt to instantiate the agent once so any validation and hooks get run</span>
-58: <span class="ruby-comment cmt"># this does a basic sanity check on the agent as a whole, if this fails it</span>
-59: <span class="ruby-comment cmt"># will be removed from the plugin list</span>
-60: <span class="ruby-constant">PluginManager</span>[<span class="ruby-node">"#{agentname}_agent"</span>]
-61:
-62: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-constant">Util</span>.<span class="ruby-identifier">make_subscriptions</span>(<span class="ruby-identifier">agentname</span>, <span class="ruby-identifier">:broadcast</span>)) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@@agents</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">agentname</span>)
-63:
-64: <span class="ruby-ivar">@@agents</span>[<span class="ruby-identifier">agentname</span>] = {<span class="ruby-identifier">:file</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">agentfile</span>}
-65: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-66: <span class="ruby-keyword kw">else</span>
-67: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Not activating agent #{agentname} due to agent policy in activate? method"</span>)
-68: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
-69: <span class="ruby-keyword kw">end</span>
-70: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-71: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Loading agent #{agentname} failed: #{e}"</span>)
-72: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-node">"#{agentname}_agent"</span>)
-73: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
-74: <span class="ruby-keyword kw">end</span>
-75: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000484" class="method-detail">
- <a name="M000484"></a>
-
- <div class="method-heading">
- <a href="#M000484" class="method-signature">
- <span class="method-name">loadagents</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Loads all agents from disk
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000484-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000484-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/agents.rb, line 25</span>
-25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">loadagents</span>
-26: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Reloading all agents from disk"</span>)
-27:
-28: <span class="ruby-identifier">clear!</span>
-29:
-30: <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">libdir</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">libdir</span><span class="ruby-operator">|</span>
-31: <span class="ruby-identifier">agentdir</span> = <span class="ruby-node">"#{libdir}/mcollective/agent"</span>
-32: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">agentdir</span>)
-33:
-34: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">agentdir</span>).<span class="ruby-identifier">grep</span>(<span class="ruby-regexp re">/\.rb$/</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">agent</span><span class="ruby-operator">|</span>
-35: <span class="ruby-identifier">agentname</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-value str">".rb"</span>)
-36: <span class="ruby-identifier">loadagent</span>(<span class="ruby-identifier">agentname</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-node">"#{agentname}_agent"</span>)
-37: <span class="ruby-keyword kw">end</span>
-38: <span class="ruby-keyword kw">end</span>
-39: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Aggregate</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Aggregate</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/aggregate_rb.html">
- lib/mcollective/aggregate.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/aggregate/base_rb.html">
- lib/mcollective/aggregate/base.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/aggregate/result/base_rb.html">
- lib/mcollective/aggregate/result/base.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/aggregate/result/collection_result_rb.html">
- lib/mcollective/aggregate/result/collection_result.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/aggregate/result/numeric_result_rb.html">
- lib/mcollective/aggregate/result/numeric_result.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/aggregate/result_rb.html">
- lib/mcollective/aggregate/result.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000412">call_functions</a>
- <a href="#M000411">contains_output?</a>
- <a href="#M000410">create_functions</a>
- <a href="#M000414">load_function</a>
- <a href="#M000409">new</a>
- <a href="#M000413">summarize</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Module <a href="Aggregate/Result.html" class="link">MCollective::Aggregate::Result</a><br />
-Class <a href="Aggregate/Base.html" class="link">MCollective::Aggregate::Base</a><br />
-
- </div>
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">action</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ddl</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">failed</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">functions</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000409" class="method-detail">
- <a name="M000409"></a>
-
- <div class="method-heading">
- <a href="#M000409" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(ddl)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000409-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000409-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 8</span>
- 8: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">ddl</span>)
- 9: <span class="ruby-ivar">@functions</span> = []
-10: <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">ddl</span>
-11: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">ddl</span>[<span class="ruby-identifier">:action</span>]
-12: <span class="ruby-ivar">@failed</span> = []
-13:
-14: <span class="ruby-identifier">create_functions</span>
-15: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000412" class="method-detail">
- <a name="M000412"></a>
-
- <div class="method-heading">
- <a href="#M000412" class="method-signature">
- <span class="method-name">call_functions</span><span class="method-args">(reply)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Call all the appropriate functions with the reply data received from <a
-href="RPC/Client.html">RPC::Client</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000412-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000412-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 45</span>
-45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call_functions</span>(<span class="ruby-identifier">reply</span>)
-46: <span class="ruby-ivar">@functions</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">function</span><span class="ruby-operator">|</span>
-47: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Calling aggregate function #{function} for result"</span>)
-48: <span class="ruby-keyword kw">begin</span>
-49: <span class="ruby-identifier">function</span>.<span class="ruby-identifier">process_result</span>(<span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:data</span>][<span class="ruby-identifier">function</span>.<span class="ruby-identifier">output_name</span>], <span class="ruby-identifier">reply</span>)
-50: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-51: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Could not process aggregate function for '#{function.output_name}'. #{e.to_s}"</span>)
-52: <span class="ruby-ivar">@failed</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">function</span>.<span class="ruby-identifier">output_name</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:process_result</span>}
-53: <span class="ruby-ivar">@functions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">function</span>)
-54: <span class="ruby-keyword kw">end</span>
-55: <span class="ruby-keyword kw">end</span>
-56: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000411" class="method-detail">
- <a name="M000411"></a>
-
- <div class="method-heading">
- <a href="#M000411" class="method-signature">
- <span class="method-name">contains_output?</span><span class="method-args">(output)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Check if the function param is defined as an output for the action in the
-ddl
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000411-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000411-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 40</span>
-40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">contains_output?</span>(<span class="ruby-identifier">output</span>)
-41: <span class="ruby-ivar">@ddl</span>[<span class="ruby-identifier">:output</span>].<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">output</span>)
-42: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000410" class="method-detail">
- <a name="M000410"></a>
-
- <div class="method-heading">
- <a href="#M000410" class="method-signature">
- <span class="method-name">create_functions</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates instances of the <a href="Aggregate.html">Aggregate</a> functions
-and stores them in the function array. All aggregate call and <a
-href="Aggregate.html#M000413">summarize</a> method calls operate on these
-function as a batch.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000410-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000410-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 19</span>
-19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_functions</span>
-20: <span class="ruby-ivar">@ddl</span>[<span class="ruby-identifier">:aggregate</span>].<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">agg</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
-21: <span class="ruby-identifier">output</span> = <span class="ruby-identifier">agg</span>[<span class="ruby-identifier">:args</span>][<span class="ruby-value">0</span>]
-22:
-23: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">contains_output?</span>(<span class="ruby-identifier">output</span>)
-24: <span class="ruby-identifier">arguments</span> = <span class="ruby-identifier">agg</span>[<span class="ruby-identifier">:args</span>][<span class="ruby-value">1</span>]
-25: <span class="ruby-identifier">format</span> = (<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">:format</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arguments</span>) <span class="ruby-operator">||</span> <span class="ruby-keyword kw">nil</span>
-26: <span class="ruby-keyword kw">begin</span>
-27: <span class="ruby-ivar">@functions</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">load_function</span>(<span class="ruby-identifier">agg</span>[<span class="ruby-identifier">:function</span>]).<span class="ruby-identifier">new</span>(<span class="ruby-identifier">output</span>, <span class="ruby-identifier">arguments</span>, <span class="ruby-identifier">format</span>, <span class="ruby-ivar">@action</span>)
-28: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-29: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Cannot create aggregate function '#{output}'. #{e.to_s}"</span>)
-30: <span class="ruby-ivar">@failed</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">output</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:startup</span>}
-31: <span class="ruby-keyword kw">end</span>
-32: <span class="ruby-keyword kw">else</span>
-33: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Cannot create aggregate function '#{output}'. '#{output}' has not been specified as a valid ddl output."</span>)
-34: <span class="ruby-ivar">@failed</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">output</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:create</span>}
-35: <span class="ruby-keyword kw">end</span>
-36: <span class="ruby-keyword kw">end</span>
-37: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000414" class="method-detail">
- <a name="M000414"></a>
-
- <div class="method-heading">
- <a href="#M000414" class="method-signature">
- <span class="method-name">load_function</span><span class="method-args">(function_name)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Loads function from disk for use
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000414-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000414-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 76</span>
-76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_function</span>(<span class="ruby-identifier">function_name</span>)
-77: <span class="ruby-identifier">function_name</span> = <span class="ruby-identifier">function_name</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">capitalize</span>
-78:
-79: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"MCollective::Aggregate::#{function_name}"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Aggregate</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-identifier">function_name</span>)
-80: <span class="ruby-constant">Aggregate</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">function_name</span>)
-81: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span>
-82: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Aggregate function file '#{function_name.downcase}.rb' cannot be loaded"</span>
-83: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000413" class="method-detail">
- <a name="M000413"></a>
-
- <div class="method-heading">
- <a href="#M000413" class="method-signature">
- <span class="method-name">summarize</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Finalizes the function returning a result object
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000413-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000413-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 59</span>
-59: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">summarize</span>
-60: <span class="ruby-identifier">summary</span> = <span class="ruby-ivar">@functions</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">function</span><span class="ruby-operator">|</span>
-61: <span class="ruby-keyword kw">begin</span>
-62: <span class="ruby-identifier">function</span>.<span class="ruby-identifier">summarize</span>
-63: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-64: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Could not summarize aggregate result for '#{function.output_name}'. #{e.to_s}"</span>)
-65: <span class="ruby-ivar">@failed</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">function</span>.<span class="ruby-identifier">output_name</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:summarize</span>}
-66: <span class="ruby-keyword kw">nil</span>
-67: <span class="ruby-keyword kw">end</span>
-68: <span class="ruby-keyword kw">end</span>
-69:
-70: <span class="ruby-identifier">summary</span>.<span class="ruby-identifier">reject</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">nil?</span>}.<span class="ruby-identifier">sort</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span>,<span class="ruby-identifier">y</span><span class="ruby-operator">|</span>
-71: <span class="ruby-identifier">x</span>.<span class="ruby-identifier">result</span>[<span class="ruby-identifier">:output</span>] <span class="ruby-operator"><=></span> <span class="ruby-identifier">y</span>.<span class="ruby-identifier">result</span>[<span class="ruby-identifier">:output</span>]
-72: <span class="ruby-keyword kw">end</span>
-73: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Aggregate::Base</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Aggregate::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/aggregate/base_rb.html">
- lib/mcollective/aggregate/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000420">new</a>
- <a href="#M000422">result_class</a>
- <a href="#M000421">summarize</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">action</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">aggregate_format</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">arguments</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">name</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">output_name</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">result</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000420" class="method-detail">
- <a name="M000420"></a>
-
- <div class="method-heading">
- <a href="#M000420" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(output_name, arguments, aggregate_format, action)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000420-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000420-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate/base.rb, line 6</span>
- 6: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">output_name</span>, <span class="ruby-identifier">arguments</span>, <span class="ruby-identifier">aggregate_format</span>, <span class="ruby-identifier">action</span>)
- 7: <span class="ruby-ivar">@name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>
- 8: <span class="ruby-ivar">@output_name</span> = <span class="ruby-identifier">output_name</span>
- 9:
-10: <span class="ruby-comment cmt"># Any additional arguments passed in the ddl after the output field will</span>
-11: <span class="ruby-comment cmt"># be stored in the arguments array which can be used in the function</span>
-12: <span class="ruby-ivar">@arguments</span> = <span class="ruby-identifier">arguments</span>
-13: <span class="ruby-ivar">@aggregate_format</span> = <span class="ruby-identifier">aggregate_format</span>
-14: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
-15: <span class="ruby-ivar">@result</span> = {<span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">:output</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">output_name</span>}
-16:
-17: <span class="ruby-identifier">startup_hook</span>
-18: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000422" class="method-detail">
- <a name="M000422"></a>
-
- <div class="method-heading">
- <a href="#M000422" class="method-signature">
- <span class="method-name">result_class</span><span class="method-args">(type)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000422-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000422-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate/base.rb, line 35</span>
-35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">result_class</span>(<span class="ruby-identifier">type</span>)
-36: <span class="ruby-constant">Result</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-node">"#{type.to_s.capitalize}Result"</span>)
-37: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000421" class="method-detail">
- <a name="M000421"></a>
-
- <div class="method-heading">
- <a href="#M000421" class="method-signature">
- <span class="method-name">summarize</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Stops execution of the function and returns a specific ResultObject,
-aggregate functions will most likely override this but this is the simplest
-case so we might as well default to that
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000421-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000421-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate/base.rb, line 29</span>
-29: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">summarize</span>
-30: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Result type is not set while trying to summarize aggregate function results"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:type</span>]
-31:
-32: <span class="ruby-identifier">result_class</span>(<span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:type</span>]).<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@result</span>, <span class="ruby-ivar">@aggregate_format</span>, <span class="ruby-ivar">@action</span>)
-33: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::Aggregate::Result</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Aggregate::Result</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/aggregate/result/base_rb.html">
- lib/mcollective/aggregate/result/base.rb
- </a>
- <br />
- <a href="../../../files/lib/mcollective/aggregate/result/collection_result_rb.html">
- lib/mcollective/aggregate/result/collection_result.rb
- </a>
- <br />
- <a href="../../../files/lib/mcollective/aggregate/result/numeric_result_rb.html">
- lib/mcollective/aggregate/result/numeric_result.rb
- </a>
- <br />
- <a href="../../../files/lib/mcollective/aggregate/result_rb.html">
- lib/mcollective/aggregate/result.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Class <a href="Result/Base.html" class="link">MCollective::Aggregate::Result::Base</a><br />
-Class <a href="Result/CollectionResult.html" class="link">MCollective::Aggregate::Result::CollectionResult</a><br />
-Class <a href="Result/NumericResult.html" class="link">MCollective::Aggregate::Result::NumericResult</a><br />
-
- </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Aggregate::Result::Base</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Aggregate::Result::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../../files/lib/mcollective/aggregate/result/base_rb.html">
- lib/mcollective/aggregate/result/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000416">new</a>
- <a href="#M000418">result_type</a>
- <a href="#M000417">to_s</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">action</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">aggregate_format</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">result</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000416" class="method-detail">
- <a name="M000416"></a>
-
- <div class="method-heading">
- <a href="#M000416" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(result, aggregate_format, action)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000416-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000416-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/base.rb, line 7</span>
- 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">aggregate_format</span>, <span class="ruby-identifier">action</span>)
- 8: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No aggregate_format defined in ddl or aggregate function"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">aggregate_format</span>
- 9:
-10: <span class="ruby-ivar">@result</span> = <span class="ruby-identifier">result</span>
-11: <span class="ruby-ivar">@aggregate_format</span> = <span class="ruby-identifier">aggregate_format</span>
-12: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
-13: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000418" class="method-detail">
- <a name="M000418"></a>
-
- <div class="method-heading">
- <a href="#M000418" class="method-signature">
- <span class="method-name">result_type</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000418-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000418-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/base.rb, line 19</span>
-19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">result_type</span>
-20: <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:type</span>]
-21: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000417" class="method-detail">
- <a name="M000417"></a>
-
- <div class="method-heading">
- <a href="#M000417" class="method-signature">
- <span class="method-name">to_s</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000417-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000417-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/base.rb, line 15</span>
-15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
-16: <span class="ruby-identifier">raise</span> <span class="ruby-node">"'to_s' method not implemented for result class '#{self.class}'"</span>
-17: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Aggregate::Result::CollectionResult</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Aggregate::Result::CollectionResult</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../../files/lib/mcollective/aggregate/result/collection_result_rb.html">
- lib/mcollective/aggregate/result/collection_result.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000415">to_s</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000415" class="method-detail">
- <a name="M000415"></a>
-
- <div class="method-heading">
- <a href="#M000415" class="method-signature">
- <span class="method-name">to_s</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000415-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000415-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/collection_result.rb, line 5</span>
- 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
- 6: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:value</span>].<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-keyword kw">nil</span>)
- 7:
- 8: <span class="ruby-identifier">result</span> = <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>
- 9:
-10: <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:value</span>].<span class="ruby-identifier">sort</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span>,<span class="ruby-identifier">y</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>[<span class="ruby-value">1</span>] <span class="ruby-operator"><=></span> <span class="ruby-identifier">y</span>[<span class="ruby-value">1</span>]}.<span class="ruby-identifier">reverse</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
-11: <span class="ruby-identifier">result</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@aggregate_format</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>], <span class="ruby-identifier">value</span>[<span class="ruby-value">1</span>]]
-12: <span class="ruby-keyword kw">end</span>
-13:
-14: <span class="ruby-identifier">result</span>.<span class="ruby-identifier">string</span>.<span class="ruby-identifier">chomp</span>
-15: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Aggregate::Result::NumericResult</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Aggregate::Result::NumericResult</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../../files/lib/mcollective/aggregate/result/numeric_result_rb.html">
- lib/mcollective/aggregate/result/numeric_result.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000419">to_s</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000419" class="method-detail">
- <a name="M000419"></a>
-
- <div class="method-heading">
- <a href="#M000419" class="method-signature">
- <span class="method-name">to_s</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000419-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000419-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/numeric_result.rb, line 5</span>
-5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
-6: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:value</span>].<span class="ruby-identifier">nil?</span>
-7:
-8: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@aggregate_format</span> <span class="ruby-operator">%</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:value</span>]
-9: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Applications</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Applications</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/applications_rb.html">
- lib/mcollective/applications.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000425">[]</a>
- <a href="#M000429">filter_extra_options</a>
- <a href="#M000428">list</a>
- <a href="#M000427">load_application</a>
- <a href="#M000430">load_config</a>
- <a href="#M000426">run</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000425" class="method-detail">
- <a name="M000425"></a>
-
- <div class="method-heading">
- <a href="#M000425" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(appname)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000425-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000425-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/applications.rb, line 3</span>
-3: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">appname</span>)
-4: <span class="ruby-identifier">load_application</span>(<span class="ruby-identifier">appname</span>)
-5: <span class="ruby-constant">PluginManager</span>[<span class="ruby-node">"#{appname}_application"</span>]
-6: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000429" class="method-detail">
- <a name="M000429"></a>
-
- <div class="method-heading">
- <a href="#M000429" class="method-signature">
- <span class="method-name">filter_extra_options</span><span class="method-args">(opts)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Filters a string of opts out using Shellwords keeping only things related
-to —config and -c
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000429-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000429-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/applications.rb, line 49</span>
-49: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">filter_extra_options</span>(<span class="ruby-identifier">opts</span>)
-50: <span class="ruby-identifier">res</span> = <span class="ruby-value str">""</span>
-51: <span class="ruby-identifier">words</span> = <span class="ruby-constant">Shellwords</span>.<span class="ruby-identifier">shellwords</span>(<span class="ruby-identifier">opts</span>)
-52: <span class="ruby-identifier">words</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">word</span>,<span class="ruby-identifier">idx</span><span class="ruby-operator">|</span>
-53: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">word</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"-c"</span>
-54: <span class="ruby-keyword kw">return</span> <span class="ruby-node">"--config=#{words[idx + 1]}"</span>
-55: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">word</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"--config"</span>
-56: <span class="ruby-keyword kw">return</span> <span class="ruby-node">"--config=#{words[idx + 1]}"</span>
-57: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">word</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/\-c=/</span>
-58: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">word</span>
-59: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">word</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/\-\-config=/</span>
-60: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">word</span>
-61: <span class="ruby-keyword kw">end</span>
-62: <span class="ruby-keyword kw">end</span>
-63:
-64: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span>
-65: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000428" class="method-detail">
- <a name="M000428"></a>
-
- <div class="method-heading">
- <a href="#M000428" class="method-signature">
- <span class="method-name">list</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns an array of applications found in the lib dirs
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000428-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000428-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/applications.rb, line 36</span>
-36: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">list</span>
-37: <span class="ruby-identifier">load_config</span>
-38:
-39: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find</span>(<span class="ruby-value str">"application"</span>)
-40: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">SystemExit</span>
-41: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
-42: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-43: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Failed to generate application list: #{e.class}: #{e}"</span>
-44: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
-45: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000427" class="method-detail">
- <a name="M000427"></a>
-
- <div class="method-heading">
- <a href="#M000427" class="method-signature">
- <span class="method-name">load_application</span><span class="method-args">(appname)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000427-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000427-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/applications.rb, line 26</span>
-26: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_application</span>(<span class="ruby-identifier">appname</span>)
-27: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-node">"#{appname}_application"</span>)
-28:
-29: <span class="ruby-identifier">load_config</span>
-30:
-31: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span> <span class="ruby-node">"MCollective::Application::#{appname.capitalize}"</span>
-32: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{appname}_application"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-node">"MCollective::Application::#{appname.capitalize}"</span>}
-33: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000430" class="method-detail">
- <a name="M000430"></a>
-
- <div class="method-heading">
- <a href="#M000430" class="method-signature">
- <span class="method-name">load_config</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-We need to know the config file in order to know the libdir so that we can
-find applications.
-</p>
-<p>
-The problem is the CLI might be stuffed with options only the app in the
-libdir might understand so we have a chicken and egg situation.
-</p>
-<p>
-We‘re parsing and filtering MCOLLECTIVE_EXTRA_OPTS removing all but
-config related options and parsing the options looking just for the config
-file.
-</p>
-<p>
-We‘re handling failures gracefully and finally restoring the ARG and
-MCOLLECTIVE_EXTRA_OPTS to the state they were before we started parsing.
-</p>
-<p>
-This is mostly a hack, when we‘re redoing how config works this stuff
-should be made less sucky
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000430-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000430-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/applications.rb, line 84</span>
- 84: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_config</span>
- 85: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">configured</span>
- 86:
- 87: <span class="ruby-identifier">original_argv</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">clone</span>
- 88: <span class="ruby-identifier">original_extra_opts</span> = <span class="ruby-constant">ENV</span>[<span class="ruby-value str">"MCOLLECTIVE_EXTRA_OPTS"</span>].<span class="ruby-identifier">clone</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
- 89: <span class="ruby-identifier">configfile</span> = <span class="ruby-keyword kw">nil</span>
- 90:
- 91: <span class="ruby-identifier">parser</span> = <span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">new</span>
- 92: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"--config CONFIG"</span>, <span class="ruby-value str">"-c"</span>, <span class="ruby-value str">"Config file"</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
- 93: <span class="ruby-identifier">configfile</span> = <span class="ruby-identifier">f</span>
- 94: <span class="ruby-keyword kw">end</span>
- 95:
- 96: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">program_name</span> = <span class="ruby-identifier">$0</span>
- 97:
- 98: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"--help"</span>)
- 99:
-100: <span class="ruby-comment cmt"># avoid option parsers own internal version handling that sux</span>
-101: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-v"</span>, <span class="ruby-value str">"--verbose"</span>)
-102:
-103: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">original_extra_opts</span>
-104: <span class="ruby-keyword kw">begin</span>
-105: <span class="ruby-comment cmt"># optparse will parse the whole ENV in one go and refuse</span>
-106: <span class="ruby-comment cmt"># to play along with the retry trick I do below so in</span>
-107: <span class="ruby-comment cmt"># order to handle unknown options properly I parse out</span>
-108: <span class="ruby-comment cmt"># only -c and --config deleting everything else and</span>
-109: <span class="ruby-comment cmt"># then restore the environment variable later when I</span>
-110: <span class="ruby-comment cmt"># am done with it</span>
-111: <span class="ruby-constant">ENV</span>[<span class="ruby-value str">"MCOLLECTIVE_EXTRA_OPTS"</span>] = <span class="ruby-identifier">filter_extra_options</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-value str">"MCOLLECTIVE_EXTRA_OPTS"</span>].<span class="ruby-identifier">clone</span>)
-112: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">environment</span>(<span class="ruby-value str">"MCOLLECTIVE_EXTRA_OPTS"</span>)
-113: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-114: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Failed to parse MCOLLECTIVE_EXTRA_OPTS: #{e}"</span>)
-115: <span class="ruby-keyword kw">end</span>
-116:
-117: <span class="ruby-constant">ENV</span>[<span class="ruby-value str">"MCOLLECTIVE_EXTRA_OPTS"</span>] = <span class="ruby-identifier">original_extra_opts</span>.<span class="ruby-identifier">clone</span>
-118: <span class="ruby-keyword kw">end</span>
-119:
-120: <span class="ruby-keyword kw">begin</span>
-121: <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">parse!</span>
-122: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidOption</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-123: <span class="ruby-keyword kw">retry</span>
-124: <span class="ruby-keyword kw">end</span>
-125:
-126: <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">clear</span>
-127: <span class="ruby-identifier">original_argv</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-constant">ARGV</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">a</span>}
-128:
-129: <span class="ruby-identifier">configfile</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">config_file_for_user</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">configfile</span>
-130:
-131: <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">loadconfig</span>(<span class="ruby-identifier">configfile</span>)
-132: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000426" class="method-detail">
- <a name="M000426"></a>
-
- <div class="method-heading">
- <a href="#M000426" class="method-signature">
- <span class="method-name">run</span><span class="method-args">(appname)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000426-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000426-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/applications.rb, line 8</span>
- 8: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">run</span>(<span class="ruby-identifier">appname</span>)
- 9: <span class="ruby-identifier">load_config</span>
-10:
-11: <span class="ruby-keyword kw">begin</span>
-12: <span class="ruby-identifier">load_application</span>(<span class="ruby-identifier">appname</span>)
-13: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-14: <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">first</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-value str">" <----"</span>)
-15: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Application '#{appname}' failed to load:"</span>
-16: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span>
-17: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-node">" #{e} (#{e.class})"</span>)
-18: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span>
-19: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-value str">" %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n "</span>)]
-20: <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
-21: <span class="ruby-keyword kw">end</span>
-22:
-23: <span class="ruby-constant">PluginManager</span>[<span class="ruby-node">"#{appname}_application"</span>].<span class="ruby-identifier">run</span>
-24: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::Cache</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Cache</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/cache_rb.html">
- lib/mcollective/cache.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A class to manage a number of named caches. Each cache can have a unique
-timeout for keys in it and each cache has an independent Mutex protecting
-access to it.
-</p>
-<p>
-This cache is <a href="Cache.html#M000272">setup</a> early in the process
-of loading the mcollective libraries, before any threads are created etc
-making it suitable as a cross thread cache or just a store for Mutexes you
-need to use across threads like in an <a href="Agent.html">Agent</a> or
-something.
-</p>
-<pre>
- # sets up a new cache, noop if it already exist
- Cache.setup(:ddl, 600)
- => true
-
- # writes an item to the :ddl cache, this item will
- # be valid on the cache for 600 seconds
- Cache.write(:ddl, :something, "value")
- => "value"
-
- # reads from the cache, read failures due to non existing
- # data or expired data will raise an exception
- Cache.read(:ddl, :something)
- => "value"
-
- # time left till expiry, raises if nothing is found
- Cache.ttl(:ddl, :something)
- => 500
-
- # forcibly evict something from the cache
- Cache.invalidate!(:ddl, :something)
- => "value"
-
- # deletes an entire named cache and its mutexes
- Cache.delete!(:ddl)
- => true
-
- # you can also just use this cache as a global mutex store
- Cache.setup(:mylock)
-
- Cache.synchronize(:mylock) do
- do_something()
- end
-</pre>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000273">check_cache!</a>
- <a href="#M000275">delete!</a>
- <a href="#M000274">has_cache?</a>
- <a href="#M000280">invalidate!</a>
- <a href="#M000277">read</a>
- <a href="#M000272">setup</a>
- <a href="#M000279">synchronize</a>
- <a href="#M000278">ttl</a>
- <a href="#M000276">write</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000273" class="method-detail">
- <a name="M000273"></a>
-
- <div class="method-heading">
- <a href="#M000273" class="method-signature">
- <span class="method-name">check_cache!</span><span class="method-args">(cache_name)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000273-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000273-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 70</span>
-70: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
-71: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC13</span>, <span class="ruby-value str">"Could not find a cache called '%{cache_name}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:cache_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">cache_name</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">has_cache?</span>(<span class="ruby-identifier">cache_name</span>)
-72: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000275" class="method-detail">
- <a name="M000275"></a>
-
- <div class="method-heading">
- <a href="#M000275" class="method-signature">
- <span class="method-name">delete!</span><span class="method-args">(cache_name)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000275-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000275-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 80</span>
-80: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">delete!</span>(<span class="ruby-identifier">cache_name</span>)
-81: <span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
-82:
-83: <span class="ruby-ivar">@locks_mutex</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
-84: <span class="ruby-ivar">@cache_locks</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">cache_name</span>)
-85: <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">cache_name</span>)
-86: <span class="ruby-keyword kw">end</span>
-87:
-88: <span class="ruby-keyword kw">true</span>
-89: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000274" class="method-detail">
- <a name="M000274"></a>
-
- <div class="method-heading">
- <a href="#M000274" class="method-signature">
- <span class="method-name">has_cache?</span><span class="method-args">(cache_name)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000274-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000274-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 74</span>
-74: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_cache?</span>(<span class="ruby-identifier">cache_name</span>)
-75: <span class="ruby-ivar">@locks_mutex</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
-76: <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">cache_name</span>)
-77: <span class="ruby-keyword kw">end</span>
-78: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000280" class="method-detail">
- <a name="M000280"></a>
-
- <div class="method-heading">
- <a href="#M000280" class="method-signature">
- <span class="method-name">invalidate!</span><span class="method-args">(cache_name, key)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000280-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000280-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 139</span>
-139: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">invalidate!</span>(<span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">key</span>)
-140: <span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
-141:
-142: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
-143: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
-144:
-145: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
-146: <span class="ruby-keyword kw">end</span>
-147: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000277" class="method-detail">
- <a name="M000277"></a>
-
- <div class="method-heading">
- <a href="#M000277" class="method-signature">
- <span class="method-name">read</span><span class="method-args">(cache_name, key)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000277-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000277-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 103</span>
-103: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">key</span>)
-104: <span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
-105:
-106: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">ttl</span>(<span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">key</span>) <span class="ruby-operator">></span> <span class="ruby-value">0</span>
-107: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC11</span>, <span class="ruby-value str">"Cache expired on '%{cache_name}' key '%{item}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:cache_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">:item</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>)
-108: <span class="ruby-keyword kw">end</span>
-109:
-110: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC12</span>, <span class="ruby-value str">"Cache hit on '%{cache_name}' key '%{item}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:cache_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">:item</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>)
-111:
-112: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
-113: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>][<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:value</span>]
-114: <span class="ruby-keyword kw">end</span>
-115: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000272" class="method-detail">
- <a name="M000272"></a>
-
- <div class="method-heading">
- <a href="#M000272" class="method-signature">
- <span class="method-name">setup</span><span class="method-args">(cache_name, ttl=300)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000272-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000272-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 56</span>
-56: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">setup</span>(<span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">ttl</span>=<span class="ruby-value">300</span>)
-57: <span class="ruby-ivar">@locks_mutex</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
-58: <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@cache_locks</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">cache_name</span>)
-59:
-60: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>] = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
-61:
-62: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
-63: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>] = {<span class="ruby-identifier">:max_age</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Float</span>(<span class="ruby-identifier">ttl</span>)}
-64: <span class="ruby-keyword kw">end</span>
-65: <span class="ruby-keyword kw">end</span>
-66:
-67: <span class="ruby-keyword kw">true</span>
-68: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000279" class="method-detail">
- <a name="M000279"></a>
-
- <div class="method-heading">
- <a href="#M000279" class="method-signature">
- <span class="method-name">synchronize</span><span class="method-args">(cache_name) {|| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000279-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000279-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 129</span>
-129: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">synchronize</span>(<span class="ruby-identifier">cache_name</span>)
-130: <span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
-131:
-132: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC14</span>, <span class="ruby-value str">"No block supplied to synchronize on cache '%{cache_name}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:cache_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">cache_name</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">block_given?</span>
-133:
-134: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
-135: <span class="ruby-keyword kw">yield</span>
-136: <span class="ruby-keyword kw">end</span>
-137: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000278" class="method-detail">
- <a name="M000278"></a>
-
- <div class="method-heading">
- <a href="#M000278" class="method-signature">
- <span class="method-name">ttl</span><span class="method-args">(cache_name, key)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000278-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000278-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 117</span>
-117: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ttl</span>(<span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">key</span>)
-118: <span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
-119:
-120: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
-121: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
-122: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC15</span>, <span class="ruby-value str">"No item called '%{item}' for cache '%{cache_name}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:cache_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">:item</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>)
-123: <span class="ruby-keyword kw">end</span>
-124:
-125: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>][<span class="ruby-identifier">:max_age</span>] <span class="ruby-operator">-</span> (<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>][<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:cache_create_time</span>])
-126: <span class="ruby-keyword kw">end</span>
-127: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000276" class="method-detail">
- <a name="M000276"></a>
-
- <div class="method-heading">
- <a href="#M000276" class="method-signature">
- <span class="method-name">write</span><span class="method-args">(cache_name, key, value)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000276-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000276-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/cache.rb, line 91</span>
- 91: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">cache_name</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>)
- 92: <span class="ruby-identifier">check_cache!</span>(<span class="ruby-identifier">cache_name</span>)
- 93:
- 94: <span class="ruby-ivar">@cache_locks</span>[<span class="ruby-identifier">cache_name</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
- 95: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>][<span class="ruby-identifier">key</span>] <span class="ruby-operator">||=</span> {}
- 96: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>][<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:cache_create_time</span>] = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
- 97: <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">cache_name</span>][<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:value</span>] = <span class="ruby-identifier">value</span>
- 98: <span class="ruby-keyword kw">end</span>
- 99:
-100: <span class="ruby-identifier">value</span>
-101: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::CodedError</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::CodedError</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- RuntimeError
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000331">log</a>
- <a href="#M000329">new</a>
- <a href="#M000330">set_backtrace</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">args</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">code</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">default</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">log_level</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000329" class="method-detail">
- <a name="M000329"></a>
-
- <div class="method-heading">
- <a href="#M000329" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(msgid, default, level=:debug, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000329-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000329-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/exception.rb, line 5</span>
- 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>=<span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">args</span>={})
- 6: <span class="ruby-ivar">@code</span> = <span class="ruby-identifier">msgid</span>
- 7: <span class="ruby-ivar">@log_level</span> = <span class="ruby-identifier">level</span>
- 8: <span class="ruby-ivar">@args</span> = <span class="ruby-identifier">args</span>
- 9: <span class="ruby-ivar">@default</span> = <span class="ruby-identifier">default</span>
-10:
-11: <span class="ruby-identifier">msg</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-ivar">@code</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-ivar">@args</span>))
-12:
-13: <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">msg</span>)
-14: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000331" class="method-detail">
- <a name="M000331"></a>
-
- <div class="method-heading">
- <a href="#M000331" class="method-signature">
- <span class="method-name">log</span><span class="method-args">(level, log_backtrace=false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000331-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000331-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/exception.rb, line 21</span>
-21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">log_backtrace</span>=<span class="ruby-keyword kw">false</span>)
-22: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">logexception</span>(<span class="ruby-ivar">@code</span>, <span class="ruby-identifier">level</span>, <span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">log_backtrace</span>)
-23: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000330" class="method-detail">
- <a name="M000330"></a>
-
- <div class="method-heading">
- <a href="#M000330" class="method-signature">
- <span class="method-name">set_backtrace</span><span class="method-args">(trace)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000330-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000330-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/exception.rb, line 16</span>
-16: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_backtrace</span>(<span class="ruby-identifier">trace</span>)
-17: <span class="ruby-keyword kw">super</span>
-18: <span class="ruby-identifier">log</span>(<span class="ruby-ivar">@log_level</span>)
-19: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Config</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Config</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/config_rb.html">
- lib/mcollective/config.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A pretty sucky config class, ripe for refactoring/improving
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000493">loadconfig</a>
- <a href="#M000492">new</a>
- <a href="#M000495">read_plugin_config_dir</a>
- <a href="#M000494">set_config_defaults</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
- <div id="includes">
- <h3 class="section-bar">Included Modules</h3>
-
- <div id="includes-list">
- <span class="include-name">Singleton</span>
- </div>
- </div>
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">classesfile</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">collectives</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">color</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">configdir</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">configfile</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">configured</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">connector</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">daemonize</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">daemonize</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">default_discovery_method</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">default_discovery_options</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">direct_addressing</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">direct_addressing_threshold</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">fact_cache_time</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">factsource</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">identity</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">keeplogs</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">libdir</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">logfacility</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">logfile</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">logger_type</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">loglevel</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">main_collective</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">max_log_size</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">mode</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">pluginconf</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">publish_timeout</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">registerinterval</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">registration</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">registration_collective</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">rpcaudit</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">rpcauditprovider</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">rpcauthorization</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">rpcauthprovider</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">rpclimitmethod</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">securityprovider</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ssl_cipher</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">threaded</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ttl</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000492" class="method-detail">
- <a name="M000492"></a>
-
- <div class="method-heading">
- <a href="#M000492" class="method-signature">
- <span class="method-name">new</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000492-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000492-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/config.rb, line 20</span>
-20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
-21: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">false</span>
-22: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000493" class="method-detail">
- <a name="M000493"></a>
-
- <div class="method-heading">
- <a href="#M000493" class="method-signature">
- <span class="method-name">loadconfig</span><span class="method-args">(configfile)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000493-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000493-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/config.rb, line 24</span>
- 24: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">loadconfig</span>(<span class="ruby-identifier">configfile</span>)
- 25: <span class="ruby-identifier">set_config_defaults</span>(<span class="ruby-identifier">configfile</span>)
- 26:
- 27: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">configfile</span>)
- 28: <span class="ruby-constant">File</span>.<span class="ruby-identifier">readlines</span>(<span class="ruby-identifier">configfile</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
- 29:
- 30: <span class="ruby-comment cmt"># strip blank spaces, tabs etc off the end of all lines</span>
- 31: <span class="ruby-identifier">line</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/\s*$/</span>, <span class="ruby-value str">""</span>)
- 32:
- 33: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">line</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^#|^$/</span>
- 34: <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">line</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/(.+?)\s*=\s*(.+)/</span>)
- 35: <span class="ruby-identifier">key</span> = <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">strip</span>
- 36: <span class="ruby-identifier">val</span> = <span class="ruby-identifier">$2</span>
- 37:
- 38: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">key</span>
- 39: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"registration"</span>
- 40: <span class="ruby-ivar">@registration</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">capitalize</span>
- 41: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"registration_collective"</span>
- 42: <span class="ruby-ivar">@registration_collective</span> = <span class="ruby-identifier">val</span>
- 43: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"registerinterval"</span>
- 44: <span class="ruby-ivar">@registerinterval</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
- 45: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"collectives"</span>
- 46: <span class="ruby-ivar">@collectives</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">","</span>).<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">strip</span>}
- 47: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"main_collective"</span>
- 48: <span class="ruby-ivar">@main_collective</span> = <span class="ruby-identifier">val</span>
- 49: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"logfile"</span>
- 50: <span class="ruby-ivar">@logfile</span> = <span class="ruby-identifier">val</span>
- 51: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"keeplogs"</span>
- 52: <span class="ruby-ivar">@keeplogs</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
- 53: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"max_log_size"</span>
- 54: <span class="ruby-ivar">@max_log_size</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
- 55: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"loglevel"</span>
- 56: <span class="ruby-ivar">@loglevel</span> = <span class="ruby-identifier">val</span>
- 57: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"logfacility"</span>
- 58: <span class="ruby-ivar">@logfacility</span> = <span class="ruby-identifier">val</span>
- 59: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"libdir"</span>
- 60: <span class="ruby-identifier">paths</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">split</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">PATH_SEPARATOR</span>)
- 61: <span class="ruby-identifier">paths</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
- 62: <span class="ruby-identifier">raise</span>(<span class="ruby-value str">"libdir paths should be absolute paths but '%s' is relative"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">path</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">absolute_path?</span>(<span class="ruby-identifier">path</span>)
- 63:
- 64: <span class="ruby-ivar">@libdir</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">path</span>
- 65: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">$LOAD_PATH</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">path</span>)
- 66: <span class="ruby-identifier">$LOAD_PATH</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">path</span>
- 67: <span class="ruby-keyword kw">end</span>
- 68: <span class="ruby-keyword kw">end</span>
- 69: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"identity"</span>
- 70: <span class="ruby-ivar">@identity</span> = <span class="ruby-identifier">val</span>
- 71: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"direct_addressing"</span>
- 72: <span class="ruby-ivar">@direct_addressing</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
- 73: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"direct_addressing_threshold"</span>
- 74: <span class="ruby-ivar">@direct_addressing_threshold</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
- 75: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"color"</span>
- 76: <span class="ruby-ivar">@color</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
- 77: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"daemonize"</span>
- 78: <span class="ruby-ivar">@daemonize</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
- 79: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"securityprovider"</span>
- 80: <span class="ruby-ivar">@securityprovider</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">capitalize</span>
- 81: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"factsource"</span>
- 82: <span class="ruby-ivar">@factsource</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">capitalize</span>
- 83: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"connector"</span>
- 84: <span class="ruby-ivar">@connector</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">capitalize</span>
- 85: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"classesfile"</span>
- 86: <span class="ruby-ivar">@classesfile</span> = <span class="ruby-identifier">val</span>
- 87: <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/^plugin.(.+)$/</span>
- 88: <span class="ruby-ivar">@pluginconf</span>[<span class="ruby-identifier">$1</span>] = <span class="ruby-identifier">val</span>
- 89: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"publish_timeout"</span>
- 90: <span class="ruby-ivar">@publish_timeout</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
- 91: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"rpcaudit"</span>
- 92: <span class="ruby-ivar">@rpcaudit</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
- 93: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"rpcauditprovider"</span>
- 94: <span class="ruby-ivar">@rpcauditprovider</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">capitalize</span>
- 95: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"rpcauthorization"</span>
- 96: <span class="ruby-ivar">@rpcauthorization</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
- 97: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"rpcauthprovider"</span>
- 98: <span class="ruby-ivar">@rpcauthprovider</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">capitalize</span>
- 99: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"rpclimitmethod"</span>
-100: <span class="ruby-ivar">@rpclimitmethod</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_sym</span>
-101: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"logger_type"</span>
-102: <span class="ruby-ivar">@logger_type</span> = <span class="ruby-identifier">val</span>
-103: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"fact_cache_time"</span>
-104: <span class="ruby-ivar">@fact_cache_time</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
-105: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"ssl_cipher"</span>
-106: <span class="ruby-ivar">@ssl_cipher</span> = <span class="ruby-identifier">val</span>
-107: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"threaded"</span>
-108: <span class="ruby-ivar">@threaded</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
-109: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"ttl"</span>
-110: <span class="ruby-ivar">@ttl</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
-111: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"default_discovery_options"</span>
-112: <span class="ruby-ivar">@default_discovery_options</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">val</span>
-113: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"default_discovery_method"</span>
-114: <span class="ruby-ivar">@default_discovery_method</span> = <span class="ruby-identifier">val</span>
-115: <span class="ruby-keyword kw">else</span>
-116: <span class="ruby-identifier">raise</span>(<span class="ruby-node">"Unknown config parameter '#{key}'"</span>)
-117: <span class="ruby-keyword kw">end</span>
-118: <span class="ruby-keyword kw">end</span>
-119: <span class="ruby-keyword kw">end</span>
-120: <span class="ruby-keyword kw">end</span>
-121:
-122: <span class="ruby-identifier">raise</span>(<span class="ruby-value str">'The %s config file does not specify a libdir setting, cannot continue'</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">configfile</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@libdir</span>.<span class="ruby-identifier">empty?</span>
-123:
-124: <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">load_path</span> = <span class="ruby-constant">Dir</span>[<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">"locales"</span>, <span class="ruby-value str">"*.yml"</span>))]
-125: <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">locale</span> = <span class="ruby-identifier">:en</span>
-126:
-127: <span class="ruby-identifier">read_plugin_config_dir</span>(<span class="ruby-node">"#{@configdir}/plugin.d"</span>)
-128:
-129: <span class="ruby-identifier">raise</span> <span class="ruby-value str">'Identities can only match /\w\.\-/'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@identity</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^[\w\.\-]+$/</span>)
-130:
-131: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">true</span>
-132:
-133: <span class="ruby-ivar">@libdir</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">dir</span><span class="ruby-operator">|</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Cannot find libdir: #{dir}"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">dir</span>)}
-134:
-135: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@logger_type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"syslog"</span>
-136: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"The sylog logger is not usable on the Windows platform"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
-137: <span class="ruby-keyword kw">end</span>
-138:
-139: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"Mcollective::Facts::#{@factsource}_facts"</span>)
-140: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"Mcollective::Connector::#{@connector}"</span>)
-141: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"Mcollective::Security::#{@securityprovider}"</span>)
-142: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"Mcollective::Registration::#{@registration}"</span>)
-143: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"Mcollective::Audit::#{@rpcauditprovider}"</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@rpcaudit</span>
-144: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"global_stats"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-constant">RunnerStats</span>.<span class="ruby-identifier">new</span>}
-145:
-146: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">logmsg</span>(<span class="ruby-identifier">:PLMC1</span>, <span class="ruby-value str">"The Marionette Collective version %{version} started by %{name} using config file %{config}"</span>, <span class="ruby-identifier">:info</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>, <span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">$0</span>, <span class="ruby-identifier">:config</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">configfile</span>)
-147: <span class="ruby-keyword kw">else</span>
-148: <span class="ruby-identifier">raise</span>(<span class="ruby-node">"Cannot find config file '#{configfile}'"</span>)
-149: <span class="ruby-keyword kw">end</span>
-150: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000495" class="method-detail">
- <a name="M000495"></a>
-
- <div class="method-heading">
- <a href="#M000495" class="method-signature">
- <span class="method-name">read_plugin_config_dir</span><span class="method-args">(dir)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000495-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000495-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/config.rb, line 192</span>
-192: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read_plugin_config_dir</span>(<span class="ruby-identifier">dir</span>)
-193: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">dir</span>)
-194:
-195: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">dir</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pluginconfigfile</span><span class="ruby-operator">|</span>
-196: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">pluginconfigfile</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^([\w]+).cfg$/</span>
-197:
-198: <span class="ruby-identifier">plugin</span> = <span class="ruby-identifier">$1</span>
-199: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-node">"#{dir}/#{pluginconfigfile}"</span>, <span class="ruby-value str">"r"</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
-200: <span class="ruby-comment cmt"># strip blank lines</span>
-201: <span class="ruby-identifier">line</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/\s*$/</span>, <span class="ruby-value str">""</span>)
-202: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">line</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^#|^$/</span>
-203: <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">line</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/(.+?)\s*=\s*(.+)/</span>)
-204: <span class="ruby-identifier">key</span> = <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">strip</span>
-205: <span class="ruby-identifier">val</span> = <span class="ruby-identifier">$2</span>
-206: <span class="ruby-ivar">@pluginconf</span>[<span class="ruby-node">"#{plugin}.#{key}"</span>] = <span class="ruby-identifier">val</span>
-207: <span class="ruby-keyword kw">end</span>
-208: <span class="ruby-keyword kw">end</span>
-209: <span class="ruby-keyword kw">end</span>
-210: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000494" class="method-detail">
- <a name="M000494"></a>
-
- <div class="method-heading">
- <a href="#M000494" class="method-signature">
- <span class="method-name">set_config_defaults</span><span class="method-args">(configfile)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000494-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000494-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/config.rb, line 152</span>
-152: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_config_defaults</span>(<span class="ruby-identifier">configfile</span>)
-153: <span class="ruby-ivar">@stomp</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
-154: <span class="ruby-ivar">@subscribe</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
-155: <span class="ruby-ivar">@pluginconf</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
-156: <span class="ruby-ivar">@connector</span> = <span class="ruby-value str">"activemq"</span>
-157: <span class="ruby-ivar">@securityprovider</span> = <span class="ruby-value str">"Psk"</span>
-158: <span class="ruby-ivar">@factsource</span> = <span class="ruby-value str">"Yaml"</span>
-159: <span class="ruby-ivar">@identity</span> = <span class="ruby-constant">Socket</span>.<span class="ruby-identifier">gethostname</span>
-160: <span class="ruby-ivar">@registration</span> = <span class="ruby-value str">"Agentlist"</span>
-161: <span class="ruby-ivar">@registerinterval</span> = <span class="ruby-value">0</span>
-162: <span class="ruby-ivar">@registration_collective</span> = <span class="ruby-keyword kw">nil</span>
-163: <span class="ruby-ivar">@classesfile</span> = <span class="ruby-value str">"/var/lib/puppet/state/classes.txt"</span>
-164: <span class="ruby-ivar">@rpcaudit</span> = <span class="ruby-keyword kw">false</span>
-165: <span class="ruby-ivar">@rpcauditprovider</span> = <span class="ruby-value str">""</span>
-166: <span class="ruby-ivar">@rpcauthorization</span> = <span class="ruby-keyword kw">false</span>
-167: <span class="ruby-ivar">@rpcauthprovider</span> = <span class="ruby-value str">""</span>
-168: <span class="ruby-ivar">@configdir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">configfile</span>)
-169: <span class="ruby-ivar">@color</span> = <span class="ruby-operator">!</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
-170: <span class="ruby-ivar">@configfile</span> = <span class="ruby-identifier">configfile</span>
-171: <span class="ruby-ivar">@logger_type</span> = <span class="ruby-value str">"file"</span>
-172: <span class="ruby-ivar">@keeplogs</span> = <span class="ruby-value">5</span>
-173: <span class="ruby-ivar">@max_log_size</span> = <span class="ruby-value">2097152</span>
-174: <span class="ruby-ivar">@rpclimitmethod</span> = <span class="ruby-identifier">:first</span>
-175: <span class="ruby-ivar">@libdir</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
-176: <span class="ruby-ivar">@fact_cache_time</span> = <span class="ruby-value">300</span>
-177: <span class="ruby-ivar">@loglevel</span> = <span class="ruby-value str">"info"</span>
-178: <span class="ruby-ivar">@logfacility</span> = <span class="ruby-value str">"user"</span>
-179: <span class="ruby-ivar">@collectives</span> = [<span class="ruby-value str">"mcollective"</span>]
-180: <span class="ruby-ivar">@main_collective</span> = <span class="ruby-ivar">@collectives</span>.<span class="ruby-identifier">first</span>
-181: <span class="ruby-ivar">@ssl_cipher</span> = <span class="ruby-value str">"aes-256-cbc"</span>
-182: <span class="ruby-ivar">@direct_addressing</span> = <span class="ruby-keyword kw">true</span>
-183: <span class="ruby-ivar">@direct_addressing_threshold</span> = <span class="ruby-value">10</span>
-184: <span class="ruby-ivar">@default_discovery_method</span> = <span class="ruby-value str">"mc"</span>
-185: <span class="ruby-ivar">@default_discovery_options</span> = []
-186: <span class="ruby-ivar">@ttl</span> = <span class="ruby-value">60</span>
-187: <span class="ruby-ivar">@mode</span> = <span class="ruby-identifier">:client</span>
-188: <span class="ruby-ivar">@publish_timeout</span> = <span class="ruby-value">2</span>
-189: <span class="ruby-ivar">@threaded</span> = <span class="ruby-keyword kw">false</span>
-190: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::Connector</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Connector</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/connector_rb.html">
- lib/mcollective/connector.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/connector/base_rb.html">
- lib/mcollective/connector/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-<a href="Connector.html">Connector</a> plugins handle the communications
-with the middleware, you can provide your own to speak to something other
-than Stomp, your plugins must inherit from <a
-href="Connector/Base.html">MCollective::Connector::Base</a> and should
-provide the following methods:
-</p>
-<p>
-connect - Creates a connection to the middleware, no arguments should get
-its parameters from the config receive - Receive data from the middleware,
-should act like a blocking call only returning if/when data
-</p>
-<pre>
- was received. It should get data from all subscribed channels/topics. Individual messages
- should be returned as MCollective::Request objects with the payload provided
-</pre>
-<p>
-publish - Takes a target and msg, should send the message to the supplied
-target topic or destination subscribe - Adds a subscription to a specific
-message source unsubscribe - Removes a subscription to a specific message
-source disconnect - Disconnects from the middleware
-</p>
-<p>
-These methods are all that‘s needed for a new connector protocol and
-should hopefully be simple enough to not have tied us to Stomp.
-</p>
-
- </div>
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Class <a href="Connector/Base.html" class="link">MCollective::Connector::Base</a><br />
-
- </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Connector::Base</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Connector::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/connector/base_rb.html">
- lib/mcollective/connector/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000328">inherited</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000328" class="method-detail">
- <a name="M000328"></a>
-
- <div class="method-heading">
- <a href="#M000328" class="method-signature">
- <span class="method-name">inherited</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000328-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000328-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/connector/base.rb, line 19</span>
-19: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
-20: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"connector_plugin"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>}
-21: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::DDL</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::DDL</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/ddl/discoveryddl_rb.html">
- lib/mcollective/ddl/discoveryddl.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/ddl/agentddl_rb.html">
- lib/mcollective/ddl/agentddl.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/ddl/validatorddl_rb.html">
- lib/mcollective/ddl/validatorddl.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/ddl/base_rb.html">
- lib/mcollective/ddl/base.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/ddl/dataddl_rb.html">
- lib/mcollective/ddl/dataddl.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/ddl_rb.html">
- lib/mcollective/ddl.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A set of classes that helps create data description language files for
-plugins. You can define meta data, actions, input and output describing the
-behavior of your agent or other plugins
-</p>
-<p>
-<a href="DDL.html">DDL</a> files are used for input validation,
-constructing outputs, producing online help, informing the various display
-routines and so forth.
-</p>
-<p>
-A sample <a href="DDL.html">DDL</a> for an agent be seen below, you‘d
-put this in your agent dir as <agent name>.ddl
-</p>
-<pre>
- metadata :name => "SimpleRPC Service Agent",
- :description => "Agent to manage services using the Puppet service provider",
- :author => "R.I.Pienaar",
- :license => "GPLv2",
- :version => "1.1",
- :url => "http://mcollective-plugins.googlecode.com/",
- :timeout => 60
-
- action "status", :description => "Gets the status of a service" do
- display :always
-
- input :service,
- :prompt => "Service Name",
- :description => "The service to get the status for",
- :type => :string,
- :validation => '^[a-zA-Z\-_\d]+$',
- :optional => true,
- :maxlength => 30
-
- output :status,
- :description => "The status of service",
- :display_as => "Service Status"
- end
-</pre>
-<p>
-There are now many types of <a href="DDL.html">DDL</a> and ultimately all
-pugins should have <a href="DDL.html">DDL</a> files. The code is organized
-so that any plugin type will magically just work - they will be an instane
-of <a href="DDL/Base.html">Base</a> which has metadata and a few common
-cases.
-</p>
-<p>
-For plugin types that require more specific behaviors they can just add a
-class here that inherits from <a href="DDL/Base.html">Base</a> and add
-their specific behavior.
-</p>
-<p>
-<a href="DDL/Base.html">Base</a> defines a specific behavior for input,
-output and metadata which we‘d like to keep standard across plugin
-types so do not completely override the behavior of input. The methods are
-written that they will gladly store extra content though so you add, do not
-remove. See the <a href="DDL/AgentDDL.html">AgentDDL</a> class for an
-example where agents want a :required argument to be always set.
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000156">load_and_cache</a>
- <a href="#M000155">new</a>
- <a href="#M000157">string_to_boolean</a>
- <a href="#M000158">string_to_number</a>
- <a href="#M000159">validation_fail!</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Class <a href="DDL/AgentDDL.html" class="link">MCollective::DDL::AgentDDL</a><br />
-Class <a href="DDL/Base.html" class="link">MCollective::DDL::Base</a><br />
-Class <a href="DDL/DataDDL.html" class="link">MCollective::DDL::DataDDL</a><br />
-Class <a href="DDL/DiscoveryDDL.html" class="link">MCollective::DDL::DiscoveryDDL</a><br />
-Class <a href="DDL/ValidatorDDL.html" class="link">MCollective::DDL::ValidatorDDL</a><br />
-
- </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000156" class="method-detail">
- <a name="M000156"></a>
-
- <div class="method-heading">
- <a href="#M000156" class="method-signature">
- <span class="method-name">load_and_cache</span><span class="method-args">(*args)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000156-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000156-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl.rb, line 71</span>
-71: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_and_cache</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
-72: <span class="ruby-constant">Cache</span>.<span class="ruby-identifier">setup</span>(<span class="ruby-identifier">:ddl</span>, <span class="ruby-value">300</span>)
-73:
-74: <span class="ruby-identifier">plugin</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">first</span>
-75: <span class="ruby-identifier">args</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">type</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_s</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">type</span> = <span class="ruby-value str">"agent"</span>
-76: <span class="ruby-identifier">path</span> = <span class="ruby-value str">"%s/%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">type</span>, <span class="ruby-identifier">plugin</span>]
-77:
-78: <span class="ruby-keyword kw">begin</span>
-79: <span class="ruby-identifier">ddl</span> = <span class="ruby-constant">Cache</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">:ddl</span>, <span class="ruby-identifier">path</span>)
-80: <span class="ruby-keyword kw">rescue</span>
-81: <span class="ruby-keyword kw">begin</span>
-82: <span class="ruby-identifier">klass</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-value str">"%sDDL"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">capitalize</span>)
-83: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NameError</span>
-84: <span class="ruby-identifier">klass</span> = <span class="ruby-constant">Base</span>
-85: <span class="ruby-keyword kw">end</span>
-86:
-87: <span class="ruby-identifier">ddl</span> = <span class="ruby-constant">Cache</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">:ddl</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>))
-88: <span class="ruby-keyword kw">end</span>
-89:
-90: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">ddl</span>
-91: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000155" class="method-detail">
- <a name="M000155"></a>
-
- <div class="method-heading">
- <a href="#M000155" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(*args, &blk)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-There used to be only one big nasty <a href="DDL.html">DDL</a> class with a
-bunch of mashed together behaviors. It‘s been around for ages and we
-would rather not ask all the users to change their <a
-href="DDL.html#M000155">DDL.new</a> calls to some other factory method that
-would have this exact same behavior.
-</p>
-<p>
-So we override the behavior of <a href="DDL.html#M000155">new</a> which is
-a hugely sucky thing to do but ultimately it‘s what would be least
-disrupting to code out there today. We did though change <a
-href="DDL.html">DDL</a> to a module to make it possibly a little less
-suprising, possibly.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000155-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000155-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl.rb, line 67</span>
-67: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>)
-68: <span class="ruby-identifier">load_and_cache</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
-69: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000157" class="method-detail">
- <a name="M000157"></a>
-
- <div class="method-heading">
- <a href="#M000157" class="method-signature">
- <span class="method-name">string_to_boolean</span><span class="method-args">(val)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-As we‘re taking arguments on the command line we need a way to input
-booleans, true on the cli is a string so this method will take the ddl,
-find all arguments that are supposed to be boolean and if they are the
-strings "true"/"yes" or
-"false"/"no" turn them into the matching boolean
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000157-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000157-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl.rb, line 98</span>
- 98: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">string_to_boolean</span>(<span class="ruby-identifier">val</span>)
- 99: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> [<span class="ruby-value str">"true"</span>, <span class="ruby-value str">"t"</span>, <span class="ruby-value str">"yes"</span>, <span class="ruby-value str">"y"</span>, <span class="ruby-value str">"1"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">val</span>.<span class="ruby-identifier">downcase</span>)
-100: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">if</span> [<span class="ruby-value str">"false"</span>, <span class="ruby-value str">"f"</span>, <span class="ruby-value str">"no"</span>, <span class="ruby-value str">"n"</span>, <span class="ruby-value str">"0"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">val</span>.<span class="ruby-identifier">downcase</span>)
-101:
-102: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC17</span>, <span class="ruby-value str">"%{value} does not look like a boolean argument"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">val</span>)
-103: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000158" class="method-detail">
- <a name="M000158"></a>
-
- <div class="method-heading">
- <a href="#M000158" class="method-signature">
- <span class="method-name">string_to_number</span><span class="method-args">(val)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-a generic string to number function, if a number looks like a float it
-turns it into a float else an int. This is naive but should be sufficient
-for numbers typed on the cli in most cases
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000158-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000158-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl.rb, line 108</span>
-108: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">string_to_number</span>(<span class="ruby-identifier">val</span>)
-109: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">val</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^\d+\.\d+$/</span>
-110: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">val</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^\d+$/</span>
-111:
-112: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC16</span>, <span class="ruby-value str">"%{value} does not look like a numeric value"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">val</span>)
-113: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000159" class="method-detail">
- <a name="M000159"></a>
-
- <div class="method-heading">
- <a href="#M000159" class="method-signature">
- <span class="method-name">validation_fail!</span><span class="method-args">(code, default, level, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Various <a href="DDL.html">DDL</a> implementations will validate and raise
-on error, this is a utility method to correctly setup a <a
-href="DDLValidationError.html">DDLValidationError</a> exceptions and raise
-them
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000159-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000159-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl.rb, line 117</span>
-117: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">code</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>={})
-118: <span class="ruby-identifier">exception</span> = <span class="ruby-constant">DDLValidationError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">code</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>)
-119: <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">set_backtrace</span> <span class="ruby-identifier">caller</span>
-120:
-121: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">exception</span>
-122: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::DDL::AgentDDL</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::DDL::AgentDDL</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/ddl/agentddl_rb.html">
- lib/mcollective/ddl/agentddl.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A <a href="../DDL.html">DDL</a> class specific to agent plugins.
-</p>
-<p>
-A full <a href="../DDL.html">DDL</a> can be seen below with all the
-possible bells and whistles present.
-</p>
-<p>
-metadata :name => "Utilities and Helpers for SimpleRPC <a
-href="../Agents.html">Agents</a>",
-</p>
-<pre>
- :description => "General helpful actions that expose stats and internals to SimpleRPC clients",
- :author => "R.I.Pienaar <rip@devco.net>",
- :license => "Apache License, Version 2.0",
- :version => "1.0",
- :url => "http://marionette-collective.org/",
- :timeout => 10
-</pre>
-<p>
-<a href="AgentDDL.html#M000183">action</a> "get_fact",
-:description => "Retrieve a single fact from the fact store"
-do
-</p>
-<pre>
- display :always
-
- input :fact,
- :prompt => "The name of the fact",
- :description => "The fact to retrieve",
- :type => :string,
- :validation => '^[\w\-\.]+$',
- :optional => false,
- :maxlength => 40,
- :default => "fqdn"
-
- output :fact,
- :description => "The name of the fact being returned",
- :display_as => "Fact"
-
- output :value,
- :description => "The value of the fact",
- :display_as => "Value",
- :default => ""
-
- summarize do
- aggregate summary(:value)
- end
-</pre>
-<p>
-end
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000183">action</a>
- <a href="#M000188">action_interface</a>
- <a href="#M000189">actions</a>
- <a href="#M000181">aggregate</a>
- <a href="#M000182">display</a>
- <a href="#M000179">input</a>
- <a href="#M000185">is_function?</a>
- <a href="#M000184">method_missing</a>
- <a href="#M000178">new</a>
- <a href="#M000186">set_default_input_arguments</a>
- <a href="#M000180">summarize</a>
- <a href="#M000187">validate_rpc_request</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000178" class="method-detail">
- <a name="M000178"></a>
-
- <div class="method-heading">
- <a href="#M000178" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(plugin, plugintype=:agent, loadddl=true)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000178-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000178-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 41</span>
-41: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">plugin</span>, <span class="ruby-identifier">plugintype</span>=<span class="ruby-identifier">:agent</span>, <span class="ruby-identifier">loadddl</span>=<span class="ruby-keyword kw">true</span>)
-42: <span class="ruby-ivar">@process_aggregate_functions</span> = <span class="ruby-keyword kw">nil</span>
-43:
-44: <span class="ruby-keyword kw">super</span>
-45: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000183" class="method-detail">
- <a name="M000183"></a>
-
- <div class="method-heading">
- <a href="#M000183" class="method-signature">
- <span class="method-name">action</span><span class="method-args">(name, input, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates the definition for an <a href="AgentDDL.html#M000183">action</a>,
-you can nest <a href="AgentDDL.html#M000179">input</a> definitions inside
-the <a href="AgentDDL.html#M000183">action</a> to attach inputs and
-validation to the <a href="AgentDDL.html#M000189">actions</a>
-</p>
-<pre>
- action "status", :description => "Restarts a Service" do
- display :always
-
- input "service",
- :prompt => "Service Action",
- :description => "The action to perform",
- :type => :list,
- :optional => true,
- :list => ["start", "stop", "restart", "status"]
-
- output "status",
- :description => "The status of the service after the action"
-
- end
-</pre>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000183-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000183-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 112</span>
-112: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">action</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">input</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-113: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Action needs a :description property"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:description</span>)
-114:
-115: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@entities</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">name</span>)
-116: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>] = {}
-117: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:action</span>] = <span class="ruby-identifier">name</span>
-118: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:input</span>] = {}
-119: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:output</span>] = {}
-120: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:display</span>] = <span class="ruby-identifier">:failed</span>
-121: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">:description</span>] = <span class="ruby-identifier">input</span>[<span class="ruby-identifier">:description</span>]
-122: <span class="ruby-keyword kw">end</span>
-123:
-124: <span class="ruby-comment cmt"># if a block is passed it might be creating input methods, call it</span>
-125: <span class="ruby-comment cmt"># we set @current_entity so the input block can know what its talking</span>
-126: <span class="ruby-comment cmt"># to, this is probably an epic hack, need to improve.</span>
-127: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-identifier">name</span>
-128: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-129: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-keyword kw">nil</span>
-130: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000188" class="method-detail">
- <a name="M000188"></a>
-
- <div class="method-heading">
- <a href="#M000188" class="method-signature">
- <span class="method-name">action_interface</span><span class="method-args">(name)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns the interface for a specific <a
-href="AgentDDL.html#M000183">action</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000188-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000188-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 198</span>
-198: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">action_interface</span>(<span class="ruby-identifier">name</span>)
-199: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">name</span>] <span class="ruby-operator">||</span> {}
-200: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000189" class="method-detail">
- <a name="M000189"></a>
-
- <div class="method-heading">
- <a href="#M000189" class="method-signature">
- <span class="method-name">actions</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns an array of <a href="AgentDDL.html#M000189">actions</a> this agent
-support
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000189-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000189-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 203</span>
-203: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">actions</span>
-204: <span class="ruby-ivar">@entities</span>.<span class="ruby-identifier">keys</span>
-205: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000181" class="method-detail">
- <a name="M000181"></a>
-
- <div class="method-heading">
- <a href="#M000181" class="method-signature">
- <span class="method-name">aggregate</span><span class="method-args">(function, format = {:format => nil})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets the <a href="AgentDDL.html#M000181">aggregate</a> array for the given
-<a href="AgentDDL.html#M000183">action</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000181-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000181-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 70</span>
-70: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">aggregate</span>(<span class="ruby-identifier">function</span>, <span class="ruby-identifier">format</span> = {<span class="ruby-identifier">:format</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>})
-71: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC28</span>, <span class="ruby-value str">"Formats supplied to aggregation functions should be a hash"</span>, <span class="ruby-identifier">:error</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">format</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
-72: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC27</span>, <span class="ruby-value str">"Formats supplied to aggregation functions must have a :format key"</span>, <span class="ruby-identifier">:error</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">format</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:format</span>)
-73: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC26</span>, <span class="ruby-value str">"Functions supplied to aggregate should be a hash"</span>, <span class="ruby-identifier">:error</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">function</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
-74:
-75: <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">function</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:args</span>)) <span class="ruby-operator">&&</span> <span class="ruby-identifier">function</span>[<span class="ruby-identifier">:args</span>]
-76: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC25</span>, <span class="ruby-value str">"aggregate method for action '%{action}' missing a function parameter"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">entities</span>[<span class="ruby-ivar">@current_entity</span>][<span class="ruby-identifier">:action</span>])
-77: <span class="ruby-keyword kw">end</span>
-78:
-79: <span class="ruby-identifier">entities</span>[<span class="ruby-ivar">@current_entity</span>][<span class="ruby-identifier">:aggregate</span>] <span class="ruby-operator">||=</span> []
-80: <span class="ruby-identifier">entities</span>[<span class="ruby-ivar">@current_entity</span>][<span class="ruby-identifier">:aggregate</span>] <span class="ruby-operator"><<</span> (<span class="ruby-identifier">format</span>[<span class="ruby-identifier">:format</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-value">? </span><span class="ruby-identifier">function</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">function</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">format</span>))
-81: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000182" class="method-detail">
- <a name="M000182"></a>
-
- <div class="method-heading">
- <a href="#M000182" class="method-signature">
- <span class="method-name">display</span><span class="method-args">(pref)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets the <a href="AgentDDL.html#M000182">display</a> preference to either
-:ok, :failed, :flatten or :always operates on <a
-href="AgentDDL.html#M000183">action</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000182-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000182-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 85</span>
-85: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">display</span>(<span class="ruby-identifier">pref</span>)
-86: <span class="ruby-comment cmt"># defaults to old behavior, complain if its supplied and invalid</span>
-87: <span class="ruby-keyword kw">unless</span> [<span class="ruby-identifier">:ok</span>, <span class="ruby-identifier">:failed</span>, <span class="ruby-identifier">:flatten</span>, <span class="ruby-identifier">:always</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">pref</span>)
-88: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Display preference #{pref} is not valid, should be :ok, :failed, :flatten or :always"</span>
-89: <span class="ruby-keyword kw">end</span>
-90:
-91: <span class="ruby-identifier">action</span> = <span class="ruby-ivar">@current_entity</span>
-92: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">action</span>][<span class="ruby-identifier">:display</span>] = <span class="ruby-identifier">pref</span>
-93: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000179" class="method-detail">
- <a name="M000179"></a>
-
- <div class="method-heading">
- <a href="#M000179" class="method-signature">
- <span class="method-name">input</span><span class="method-args">(argument, properties)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000179-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000179-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 47</span>
-47: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">input</span>(<span class="ruby-identifier">argument</span>, <span class="ruby-identifier">properties</span>)
-48: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Input needs a :optional property"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">properties</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:optional</span>)
-49:
-50: <span class="ruby-keyword kw">super</span>
-51: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000185" class="method-detail">
- <a name="M000185"></a>
-
- <div class="method-heading">
- <a href="#M000185" class="method-signature">
- <span class="method-name">is_function?</span><span class="method-args">(method_name)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Checks if a method name matches a <a
-href="AgentDDL.html#M000181">aggregate</a> plugin. This is used by method
-missing so that we dont greedily assume that every <a
-href="AgentDDL.html#M000184">method_missing</a> call in an agent ddl has
-hit a <a href="AgentDDL.html#M000181">aggregate</a> function.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000185-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000185-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 146</span>
-146: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">is_function?</span>(<span class="ruby-identifier">method_name</span>)
-147: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find</span>(<span class="ruby-value str">"aggregate"</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">method_name</span>.<span class="ruby-identifier">to_s</span>)
-148: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000184" class="method-detail">
- <a name="M000184"></a>
-
- <div class="method-heading">
- <a href="#M000184" class="method-signature">
- <span class="method-name">method_missing</span><span class="method-args">(name, *args, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-If the method name matches a # <a
-href="AgentDDL.html#M000181">aggregate</a> function, we return the function
-with args as a hash. This will only be active if the
-@process_aggregate_functions is set to true which only happens in the <a
-href="AgentDDL.html#M000180">summarize</a> block
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000184-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000184-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 135</span>
-135: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-136: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@process_aggregate_functions</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">is_function?</span>(<span class="ruby-identifier">name</span>)
-137: <span class="ruby-identifier">raise</span> <span class="ruby-constant">NoMethodError</span>, <span class="ruby-node">"undefined local variable or method `#{name}'"</span>, <span class="ruby-identifier">caller</span>
-138: <span class="ruby-keyword kw">end</span>
-139:
-140: <span class="ruby-keyword kw">return</span> {<span class="ruby-identifier">:function</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">:args</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">args</span>}
-141: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000186" class="method-detail">
- <a name="M000186"></a>
-
- <div class="method-heading">
- <a href="#M000186" class="method-signature">
- <span class="method-name">set_default_input_arguments</span><span class="method-args">(action, arguments)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-For a given <a href="AgentDDL.html#M000183">action</a> and arguments look
-up the <a href="../DDL.html">DDL</a> interface to that <a
-href="AgentDDL.html#M000183">action</a> and if any arguments in the <a
-href="../DDL.html">DDL</a> have a :default value assign that to any <a
-href="AgentDDL.html#M000179">input</a> that does not have an argument in
-the <a href="AgentDDL.html#M000179">input</a> arguments
-</p>
-<p>
-This is intended to only be called on clients and not on servers as the
-clients should never be able to publish non compliant requests and the
-servers should really not tamper with incoming requests since doing so
-might raise validation errors that were not raised on the client breaking
-our fail-fast approach to <a href="AgentDDL.html#M000179">input</a>
-validation
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000186-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000186-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 159</span>
-159: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_default_input_arguments</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">arguments</span>)
-160: <span class="ruby-identifier">input</span> = <span class="ruby-identifier">action_interface</span>(<span class="ruby-identifier">action</span>)[<span class="ruby-identifier">:input</span>]
-161:
-162: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>
-163:
-164: <span class="ruby-identifier">input</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
-165: <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:default</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:optional</span>]
-166: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Setting default value for input '%s' to '%s'"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">key</span>, <span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:default</span>]])
-167: <span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:default</span>]
-168: <span class="ruby-keyword kw">end</span>
-169: <span class="ruby-keyword kw">end</span>
-170: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000180" class="method-detail">
- <a name="M000180"></a>
-
- <div class="method-heading">
- <a href="#M000180" class="method-signature">
- <span class="method-name">summarize</span><span class="method-args">(&block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Calls the <a href="AgentDDL.html#M000180">summarize</a> block defined in
-the ddl. Block will not be called if the ddl is getting processed on the
-server side. This means that <a href="AgentDDL.html#M000181">aggregate</a>
-plugins only have to be present on the client side.
-</p>
-<p>
-The @process_aggregate_functions variable is used by the <a
-href="AgentDDL.html#M000184">method_missing</a> block to determine if it
-should kick in, this way we very tightly control where we activate the <a
-href="AgentDDL.html#M000184">method_missing</a> behavior turning it into a
-noop otherwise to maximise the chance of providing good user feedback
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000180-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000180-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 61</span>
-61: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">summarize</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-62: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">mode</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:server</span>
-63: <span class="ruby-ivar">@process_aggregate_functions</span> = <span class="ruby-keyword kw">true</span>
-64: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>
-65: <span class="ruby-ivar">@process_aggregate_functions</span> = <span class="ruby-keyword kw">nil</span>
-66: <span class="ruby-keyword kw">end</span>
-67: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000187" class="method-detail">
- <a name="M000187"></a>
-
- <div class="method-heading">
- <a href="#M000187" class="method-signature">
- <span class="method-name">validate_rpc_request</span><span class="method-args">(action, arguments)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Helper to use the <a href="../DDL.html">DDL</a> to figure out if the remote
-call to an agent should be allowed based on <a
-href="AgentDDL.html#M000183">action</a> name and inputs.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000187-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000187-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/agentddl.rb, line 174</span>
-174: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_rpc_request</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">arguments</span>)
-175: <span class="ruby-comment cmt"># is the action known?</span>
-176: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">actions</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">action</span>)
-177: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC29</span>, <span class="ruby-value str">"Attempted to call action %{action} for %{plugin} but it's not declared in the DDL"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">action</span>, <span class="ruby-identifier">:plugin</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@pluginname</span>)
-178: <span class="ruby-keyword kw">end</span>
-179:
-180: <span class="ruby-identifier">input</span> = <span class="ruby-identifier">action_interface</span>(<span class="ruby-identifier">action</span>)[<span class="ruby-identifier">:input</span>] <span class="ruby-operator">||</span> {}
-181:
-182: <span class="ruby-identifier">input</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
-183: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>[<span class="ruby-identifier">key</span>][<span class="ruby-identifier">:optional</span>]
-184: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
-185: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC30</span>, <span class="ruby-value str">"Action '%{action}' needs a '%{key}' argument"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">action</span>, <span class="ruby-identifier">:key</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>)
-186: <span class="ruby-keyword kw">end</span>
-187: <span class="ruby-keyword kw">end</span>
-188:
-189: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
-190: <span class="ruby-identifier">validate_input_argument</span>(<span class="ruby-identifier">input</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">key</span>])
-191: <span class="ruby-keyword kw">end</span>
-192: <span class="ruby-keyword kw">end</span>
-193:
-194: <span class="ruby-keyword kw">true</span>
-195: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::DDL::DataDDL</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::DDL::DataDDL</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/ddl/dataddl_rb.html">
- lib/mcollective/ddl/dataddl.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A <a href="../DDL.html">DDL</a> file for the data query plugins.
-</p>
-<p>
-Query plugins can today take only one <a
-href="DataDDL.html#M000161">input</a> by convention in the <a
-href="../DDL.html">DDL</a> that is called :query, otherwise the <a
-href="DataDDL.html#M000161">input</a> is identical to the standard <a
-href="DataDDL.html#M000161">input</a>.
-</p>
-<p>
-metadata :name => "<a href="../Agent.html">Agent</a>",
-</p>
-<pre>
- :description => "Meta data about installed MColletive Agents",
- :author => "R.I.Pienaar <rip@devco.net>",
- :license => "ASL 2.0",
- :version => "1.0",
- :url => "http://marionette-collective.org/",
- :timeout => 1
-</pre>
-<p>
-<a href="DataDDL.html#M000160">dataquery</a> :description => "<a
-href="../Agent.html">Agent</a> Meta <a href="../Data.html">Data</a>"
-do
-</p>
-<pre>
- input :query,
- :prompt => "Agent Name",
- :description => "Valid agent name",
- :type => :string,
- :validation => /^[\w\_]+$/,
- :maxlength => 20
-
- [:license, :timeout, :description, :url, :version, :author].each do |item|
- output item,
- :description => "Agent #{item}",
- :display_as => item.to_s.capitalize
- end
-</pre>
-<p>
-end
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000160">dataquery</a>
- <a href="#M000162">dataquery_interface</a>
- <a href="#M000161">input</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000160" class="method-detail">
- <a name="M000160"></a>
-
- <div class="method-heading">
- <a href="#M000160" class="method-signature">
- <span class="method-name">dataquery</span><span class="method-args">(input, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000160-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000160-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 31</span>
-31: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dataquery</span>(<span class="ruby-identifier">input</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-32: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Data queries need a :description"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:description</span>)
-33: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Data queries can only have one definition"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>]
-34:
-35: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>] = {<span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">input</span>[<span class="ruby-identifier">:description</span>],
-36: <span class="ruby-identifier">:input</span> =<span class="ruby-operator">></span> {},
-37: <span class="ruby-identifier">:output</span> =<span class="ruby-operator">></span> {}}
-38:
-39: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-identifier">:data</span>
-40: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-41: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-keyword kw">nil</span>
-42: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000162" class="method-detail">
- <a name="M000162"></a>
-
- <div class="method-heading">
- <a href="#M000162" class="method-signature">
- <span class="method-name">dataquery_interface</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns the interface for the data query
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000162-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000162-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 51</span>
-51: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dataquery_interface</span>
-52: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>] <span class="ruby-operator">||</span> {}
-53: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000161" class="method-detail">
- <a name="M000161"></a>
-
- <div class="method-heading">
- <a href="#M000161" class="method-signature">
- <span class="method-name">input</span><span class="method-args">(argument, properties)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000161-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000161-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 44</span>
-44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">input</span>(<span class="ruby-identifier">argument</span>, <span class="ruby-identifier">properties</span>)
-45: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"The only valid input name for a data query is 'query'"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">argument</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">:query</span>
-46:
-47: <span class="ruby-keyword kw">super</span>
-48: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::DDL::DiscoveryDDL</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::DDL::DiscoveryDDL</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/ddl/discoveryddl_rb.html">
- lib/mcollective/ddl/discoveryddl.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-<a href="../DDL.html">DDL</a> for <a
-href="DiscoveryDDL.html#M000165">discovery</a> plugins, a full example can
-be seen below
-</p>
-<p>
-metadata :name => "mc",
-</p>
-<pre>
- :description => "MCollective Broadcast based discovery",
- :author => "R.I.Pienaar <rip@devco.net>",
- :license => "ASL 2.0",
- :version => "0.1",
- :url => "http://marionette-collective.org/",
- :timeout => 2
-</pre>
-<p>
-<a href="DiscoveryDDL.html#M000165">discovery</a> do
-</p>
-<pre>
- capabilities [:classes, :facts, :identity, :agents, :compound]
-</pre>
-<p>
-end
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000164">capabilities</a>
- <a href="#M000165">discovery</a>
- <a href="#M000163">discovery_interface</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000164" class="method-detail">
- <a name="M000164"></a>
-
- <div class="method-heading">
- <a href="#M000164" class="method-signature">
- <span class="method-name">capabilities</span><span class="method-args">(*caps)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-records valid <a href="DiscoveryDDL.html#M000164">capabilities</a> for <a
-href="DiscoveryDDL.html#M000165">discovery</a> plugins
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000164-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000164-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/discoveryddl.rb, line 22</span>
-22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">capabilities</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">caps</span>)
-23: <span class="ruby-identifier">caps</span> = [<span class="ruby-identifier">caps</span>].<span class="ruby-identifier">flatten</span>
-24:
-25: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Discovery plugin capabilities can't be empty"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">caps</span>.<span class="ruby-identifier">empty?</span>
-26:
-27: <span class="ruby-identifier">caps</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">cap</span><span class="ruby-operator">|</span>
-28: <span class="ruby-keyword kw">if</span> [<span class="ruby-identifier">:classes</span>, <span class="ruby-identifier">:facts</span>, <span class="ruby-identifier">:identity</span>, <span class="ruby-identifier">:agents</span>, <span class="ruby-identifier">:compound</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">cap</span>)
-29: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:discovery</span>][<span class="ruby-identifier">:capabilities</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">cap</span>
-30: <span class="ruby-keyword kw">else</span>
-31: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"%s is not a valid capability, valid capabilities are :classes, :facts, :identity, :agents and :compound"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">cap</span>
-32: <span class="ruby-keyword kw">end</span>
-33: <span class="ruby-keyword kw">end</span>
-34: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000165" class="method-detail">
- <a name="M000165"></a>
-
- <div class="method-heading">
- <a href="#M000165" class="method-signature">
- <span class="method-name">discovery</span><span class="method-args">(&block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates the definition for new <a
-href="DiscoveryDDL.html#M000165">discovery</a> plugins
-</p>
-<pre>
- discovery do
- capabilities [:classes, :facts, :identity, :agents, :compound]
- end
-</pre>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000165-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000165-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/discoveryddl.rb, line 41</span>
-41: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-42: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Discovery plugins can only have one definition"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:discovery</span>]
-43:
-44: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:discovery</span>] = {<span class="ruby-identifier">:capabilities</span> =<span class="ruby-operator">></span> []}
-45:
-46: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-identifier">:discovery</span>
-47: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-48: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-keyword kw">nil</span>
-49: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000163" class="method-detail">
- <a name="M000163"></a>
-
- <div class="method-heading">
- <a href="#M000163" class="method-signature">
- <span class="method-name">discovery_interface</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000163-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000163-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/ddl/discoveryddl.rb, line 17</span>
-17: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_interface</span>
-18: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:discovery</span>]
-19: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::DDL::ValidatorDDL</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::DDL::ValidatorDDL</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/ddl/validatorddl_rb.html">
- lib/mcollective/ddl/validatorddl.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::DDLValidationError</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::DDLValidationError</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="CodedError.html">
- CodedError
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Exceptions for the <a href="RPC.html">RPC</a> system
-</p>
-
- </div>
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::Data</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Data</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/data/base_rb.html">
- lib/mcollective/data/base.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/data/result_rb.html">
- lib/mcollective/data/result.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/data_rb.html">
- lib/mcollective/data.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000225">[]</a>
- <a href="#M000227">ddl</a>
- <a href="#M000229">ddl_has_output?</a>
- <a href="#M000230">ddl_transform_input</a>
- <a href="#M000228">ddl_validate</a>
- <a href="#M000223">load_data_sources</a>
- <a href="#M000226">method_missing</a>
- <a href="#M000224">pluginname</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Class <a href="Data/Base.html" class="link">MCollective::Data::Base</a><br />
-Class <a href="Data/Result.html" class="link">MCollective::Data::Result</a><br />
-
- </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000225" class="method-detail">
- <a name="M000225"></a>
-
- <div class="method-heading">
- <a href="#M000225" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(plugin)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000225-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000225-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 26</span>
-26: <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>)
-27: <span class="ruby-constant">PluginManager</span>[<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">plugin</span>)]
-28: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000227" class="method-detail">
- <a name="M000227"></a>
-
- <div class="method-heading">
- <a href="#M000227" class="method-signature">
- <span class="method-name">ddl</span><span class="method-args">(plugin)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000227-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000227-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 37</span>
-37: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ddl</span>(<span class="ruby-identifier">plugin</span>)
-38: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">plugin</span>), <span class="ruby-identifier">:data</span>)
-39: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000229" class="method-detail">
- <a name="M000229"></a>
-
- <div class="method-heading">
- <a href="#M000229" class="method-signature">
- <span class="method-name">ddl_has_output?</span><span class="method-args">(ddl, output)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000229-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000229-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 62</span>
-62: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ddl_has_output?</span>(<span class="ruby-identifier">ddl</span>, <span class="ruby-identifier">output</span>)
-63: <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">entities</span>[<span class="ruby-identifier">:data</span>][<span class="ruby-identifier">:output</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">output</span>.<span class="ruby-identifier">to_sym</span>) <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">false</span>
-64: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000230" class="method-detail">
- <a name="M000230"></a>
-
- <div class="method-heading">
- <a href="#M000230" class="method-signature">
- <span class="method-name">ddl_transform_input</span><span class="method-args">(ddl, input)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-For an input where the <a href="DDL.html">DDL</a> requests a boolean or
-some number this will convert the input to the right type where possible
-else just returns the origin input unedited
-</p>
-<p>
-if anything here goes wrong just return the input value this is not really
-the end of the world or anything since all that will happen is that <a
-href="DDL.html">DDL</a> validation will fail and the user will get an
-error, no need to be too defensive here
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000230-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000230-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 74</span>
-74: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ddl_transform_input</span>(<span class="ruby-identifier">ddl</span>, <span class="ruby-identifier">input</span>)
-75: <span class="ruby-keyword kw">begin</span>
-76: <span class="ruby-identifier">type</span> = <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">entities</span>[<span class="ruby-identifier">:data</span>][<span class="ruby-identifier">:input</span>][<span class="ruby-identifier">:query</span>][<span class="ruby-identifier">:type</span>]
-77:
-78: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">type</span>
-79: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:boolean</span>
-80: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">string_to_boolean</span>(<span class="ruby-identifier">input</span>)
-81:
-82: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:number</span>, <span class="ruby-identifier">:integer</span>, <span class="ruby-identifier">:float</span>
-83: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">string_to_number</span>(<span class="ruby-identifier">input</span>)
-84: <span class="ruby-keyword kw">end</span>
-85: <span class="ruby-keyword kw">rescue</span>
-86: <span class="ruby-keyword kw">end</span>
-87:
-88: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">input</span>
-89: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000228" class="method-detail">
- <a name="M000228"></a>
-
- <div class="method-heading">
- <a href="#M000228" class="method-signature">
- <span class="method-name">ddl_validate</span><span class="method-args">(ddl, argument)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000228-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000228-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 41</span>
-41: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ddl_validate</span>(<span class="ruby-identifier">ddl</span>, <span class="ruby-identifier">argument</span>)
-42: <span class="ruby-identifier">name</span> = <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:name</span>]
-43: <span class="ruby-identifier">query</span> = <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">entities</span>[<span class="ruby-identifier">:data</span>]
-44:
-45: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC31</span>, <span class="ruby-value str">"No dataquery has been defined in the DDL for data plugin '%{plugin}'"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:plugin</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">query</span>
-46:
-47: <span class="ruby-identifier">input</span> = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:input</span>, {})
-48: <span class="ruby-identifier">output</span> = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:output</span>, {})
-49:
-50: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC32</span>, <span class="ruby-value str">"No output has been defined in the DDL for data plugin %{plugin}"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:plugin</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">output</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">empty?</span>
-51:
-52: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">input</span>[<span class="ruby-identifier">:query</span>]
-53: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">argument</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">input</span>[<span class="ruby-identifier">:query</span>][<span class="ruby-identifier">:optional</span>]
-54:
-55: <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">validate_input_argument</span>(<span class="ruby-identifier">input</span>, <span class="ruby-identifier">:query</span>, <span class="ruby-identifier">argument</span>)
-56: <span class="ruby-keyword kw">else</span>
-57: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC33</span>, <span class="ruby-value str">"No data plugin argument was declared in the '%{plugin}' DDL but an input was supplied"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:plugin</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">argument</span>
-58: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-59: <span class="ruby-keyword kw">end</span>
-60: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000223" class="method-detail">
- <a name="M000223"></a>
-
- <div class="method-heading">
- <a href="#M000223" class="method-signature">
- <span class="method-name">load_data_sources</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000223-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000223-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 6</span>
- 6: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_data_sources</span>
- 7: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find_and_load</span>(<span class="ruby-value str">"data"</span>)
- 8:
- 9: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-regexp re">/_data$/</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">plugin</span><span class="ruby-operator">|</span>
-10: <span class="ruby-keyword kw">begin</span>
-11: <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">PluginManager</span>[<span class="ruby-identifier">plugin</span>].<span class="ruby-identifier">class</span>.<span class="ruby-identifier">activate?</span>
-12: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Disabling data plugin %s due to plugin activation policy"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">plugin</span>)
-13: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">plugin</span>)
-14: <span class="ruby-keyword kw">end</span>
-15: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-16: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Disabling data plugin %s due to exception #{e.class}: #{e}"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">plugin</span>)
-17: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">plugin</span>)
-18: <span class="ruby-keyword kw">end</span>
-19: <span class="ruby-keyword kw">end</span>
-20: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000226" class="method-detail">
- <a name="M000226"></a>
-
- <div class="method-heading">
- <a href="#M000226" class="method-signature">
- <span class="method-name">method_missing</span><span class="method-args">(method, *args)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Data.package("httpd").architecture
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000226-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000226-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 31</span>
-31: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
-32: <span class="ruby-keyword kw">super</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">method</span>))
-33:
-34: <span class="ruby-constant">PluginManager</span>[<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">method</span>)].<span class="ruby-identifier">lookup</span>(<span class="ruby-identifier">args</span>.<span class="ruby-identifier">first</span>)
-35: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000224" class="method-detail">
- <a name="M000224"></a>
-
- <div class="method-heading">
- <a href="#M000224" class="method-signature">
- <span class="method-name">pluginname</span><span class="method-args">(plugin)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000224-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000224-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data.rb, line 22</span>
-22: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">plugin</span>)
-23: <span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/_data$/i</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">:</span> <span class="ruby-value str">"%s_data"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span>
-24: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Data::Base</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Data::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/data/base_rb.html">
- lib/mcollective/data/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000243">activate?</a>
- <a href="#M000242">activate_when</a>
- <a href="#M000241">ddl_validate</a>
- <a href="#M000237">inherited</a>
- <a href="#M000239">lookup</a>
- <a href="#M000238">new</a>
- <a href="#M000240">query</a>
- <a href="#M000244">startup_hook</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ddl</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">name</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">result</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">timeout</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000243" class="method-detail">
- <a name="M000243"></a>
-
- <div class="method-heading">
- <a href="#M000243" class="method-signature">
- <span class="method-name">activate?</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Always be active unless a specific block is given with <a
-href="Base.html#M000242">activate_when</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000243-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000243-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 60</span>
-60: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">activate?</span>
-61: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-62: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000242" class="method-detail">
- <a name="M000242"></a>
-
- <div class="method-heading">
- <a href="#M000242" class="method-signature">
- <span class="method-name">activate_when</span><span class="method-args">(&block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-<a href="Base.html#M000242">activate_when</a> do
-</p>
-<pre>
- file.exist?("/usr/bin/puppet")
-</pre>
-<p>
-end
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000242-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000242-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 53</span>
-53: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">activate_when</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-54: (<span class="ruby-keyword kw">class</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">self</span>; <span class="ruby-keyword kw">self</span>; <span class="ruby-keyword kw">end</span>).<span class="ruby-identifier">instance_eval</span> <span class="ruby-keyword kw">do</span>
-55: <span class="ruby-identifier">define_method</span>(<span class="ruby-value str">"activate?"</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-56: <span class="ruby-keyword kw">end</span>
-57: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000237" class="method-detail">
- <a name="M000237"></a>
-
- <div class="method-heading">
- <a href="#M000237" class="method-signature">
- <span class="method-name">inherited</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Register plugins that inherits base
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000237-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000237-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 7</span>
- 7: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
- 8: <span class="ruby-identifier">type</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"::"</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
- 9:
-10: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">:single_instance</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>}
-11: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000238" class="method-detail">
- <a name="M000238"></a>
-
- <div class="method-heading">
- <a href="#M000238" class="method-signature">
- <span class="method-name">new</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000238-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000238-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 13</span>
-13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
-14: <span class="ruby-ivar">@name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"::"</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
-15: <span class="ruby-ivar">@ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@name</span>, <span class="ruby-identifier">:data</span>)
-16: <span class="ruby-ivar">@result</span> = <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">dataquery_interface</span>[<span class="ruby-identifier">:output</span>])
-17: <span class="ruby-ivar">@timeout</span> = <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:timeout</span>] <span class="ruby-operator">||</span> <span class="ruby-value">1</span>
-18:
-19: <span class="ruby-identifier">startup_hook</span>
-20: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000240" class="method-detail">
- <a name="M000240"></a>
-
- <div class="method-heading">
- <a href="#M000240" class="method-signature">
- <span class="method-name">query</span><span class="method-args">(&block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000240-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000240-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 42</span>
-42: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">query</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-43: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">module_eval</span> { <span class="ruby-identifier">define_method</span>(<span class="ruby-value str">"query_data"</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) }
-44: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000241" class="method-detail">
- <a name="M000241"></a>
-
- <div class="method-heading">
- <a href="#M000241" class="method-signature">
- <span class="method-name">ddl_validate</span><span class="method-args">(what)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000241-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000241-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 46</span>
-46: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ddl_validate</span>(<span class="ruby-identifier">what</span>)
-47: <span class="ruby-constant">Data</span>.<span class="ruby-identifier">ddl_validate</span>(<span class="ruby-ivar">@ddl</span>, <span class="ruby-identifier">what</span>)
-48: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000239" class="method-detail">
- <a name="M000239"></a>
-
- <div class="method-heading">
- <a href="#M000239" class="method-signature">
- <span class="method-name">lookup</span><span class="method-args">(what)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000239-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000239-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 22</span>
-22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lookup</span>(<span class="ruby-identifier">what</span>)
-23: <span class="ruby-identifier">ddl_validate</span>(<span class="ruby-identifier">what</span>)
-24:
-25: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Doing data query %s for '%s'"</span> <span class="ruby-operator">%</span> [ <span class="ruby-ivar">@name</span>, <span class="ruby-identifier">what</span> ])
-26:
-27: <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-identifier">timeout</span>(<span class="ruby-ivar">@timeout</span>) <span class="ruby-keyword kw">do</span>
-28: <span class="ruby-identifier">query_data</span>(<span class="ruby-identifier">what</span>)
-29: <span class="ruby-keyword kw">end</span>
-30:
-31: <span class="ruby-ivar">@result</span>
-32: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>
-33: <span class="ruby-comment cmt"># Timeout::Error is a inherited from Interrupt which seems a really</span>
-34: <span class="ruby-comment cmt"># strange choice, making it an equivelant of ^C and such. Catch it</span>
-35: <span class="ruby-comment cmt"># and raise something less critical that will not the runner to just</span>
-36: <span class="ruby-comment cmt"># give up the ghost</span>
-37: <span class="ruby-identifier">msg</span> = <span class="ruby-value str">"Data plugin %s timed out on query '%s'"</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@name</span>, <span class="ruby-identifier">what</span>]
-38: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">msg</span>)
-39: <span class="ruby-identifier">raise</span> <span class="ruby-constant">MsgTTLExpired</span>, <span class="ruby-identifier">msg</span>
-40: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000244" class="method-detail">
- <a name="M000244"></a>
-
- <div class="method-heading">
- <a href="#M000244" class="method-signature">
- <span class="method-name">startup_hook</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000244-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000244-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 64</span>
-64: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">startup_hook</span>;<span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Data::Result</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Data::Result</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/data/result_rb.html">
- lib/mcollective/data/result.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000233">[]</a>
- <a href="#M000234">[]=</a>
- <a href="#M000232">include?</a>
- <a href="#M000235">keys</a>
- <a href="#M000236">method_missing</a>
- <a href="#M000231">new</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000231" class="method-detail">
- <a name="M000231"></a>
-
- <div class="method-heading">
- <a href="#M000231" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(outputs)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000231-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000231-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 9</span>
- 9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">outputs</span>)
-10: <span class="ruby-ivar">@data</span> = {}
-11:
-12: <span class="ruby-identifier">outputs</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span><span class="ruby-operator">|</span>
-13: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">output</span>] = <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">outputs</span>[<span class="ruby-identifier">output</span>].<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:default</span>, <span class="ruby-keyword kw">nil</span>)))
-14: <span class="ruby-keyword kw">end</span>
-15: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000233" class="method-detail">
- <a name="M000233"></a>
-
- <div class="method-heading">
- <a href="#M000233" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(key)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000233-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000233-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 21</span>
-21: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
-22: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>]
-23: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000234" class="method-detail">
- <a name="M000234"></a>
-
- <div class="method-heading">
- <a href="#M000234" class="method-signature">
- <span class="method-name">[]=</span><span class="method-args">(key, val)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000234-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000234-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 25</span>
-25: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span>)
-26: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Can only store String, Integer, Float or Boolean data but got #{val.class} for key #{key}"</span> <span class="ruby-keyword kw">unless</span> [<span class="ruby-constant">String</span>, <span class="ruby-constant">Fixnum</span>, <span class="ruby-constant">Bignum</span>, <span class="ruby-constant">Float</span>, <span class="ruby-constant">TrueClass</span>, <span class="ruby-constant">FalseClass</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">val</span>.<span class="ruby-identifier">class</span>)
-27:
-28: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">val</span>
-29: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000232" class="method-detail">
- <a name="M000232"></a>
-
- <div class="method-heading">
- <a href="#M000232" class="method-signature">
- <span class="method-name">include?</span><span class="method-args">(key)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000232-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000232-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 17</span>
-17: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
-18: <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>)
-19: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000235" class="method-detail">
- <a name="M000235"></a>
-
- <div class="method-heading">
- <a href="#M000235" class="method-signature">
- <span class="method-name">keys</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000235-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000235-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 31</span>
-31: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">keys</span>
-32: <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">keys</span>
-33: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000236" class="method-detail">
- <a name="M000236"></a>
-
- <div class="method-heading">
- <a href="#M000236" class="method-signature">
- <span class="method-name">method_missing</span><span class="method-args">(method, *args)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000236-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000236-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 35</span>
-35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
-36: <span class="ruby-identifier">key</span> = <span class="ruby-identifier">method</span>.<span class="ruby-identifier">to_sym</span>
-37:
-38: <span class="ruby-identifier">raise</span> <span class="ruby-constant">NoMethodError</span>, <span class="ruby-value str">"undefined local variable or method `%s'"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">key</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
-39:
-40: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>]
-41: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Discovery</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Discovery</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/discovery_rb.html">
- lib/mcollective/discovery.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000404">check_capabilities</a>
- <a href="#M000403">ddl</a>
- <a href="#M000408">discover</a>
- <a href="#M000402">discovery_class</a>
- <a href="#M000401">discovery_method</a>
- <a href="#M000407">discovery_timeout</a>
- <a href="#M000398">find_known_methods</a>
- <a href="#M000400">force_direct_mode?</a>
- <a href="#M000405">force_discovery_method_by_filter</a>
- <a href="#M000399">has_method?</a>
- <a href="#M000397">new</a>
- <a href="#M000406">timeout_for_compound_filter</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000397" class="method-detail">
- <a name="M000397"></a>
-
- <div class="method-heading">
- <a href="#M000397" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(client)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000397-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000397-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 3</span>
-3: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">client</span>)
-4: <span class="ruby-ivar">@known_methods</span> = <span class="ruby-identifier">find_known_methods</span>
-5: <span class="ruby-ivar">@default_method</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">default_discovery_method</span>
-6: <span class="ruby-ivar">@client</span> = <span class="ruby-identifier">client</span>
-7: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000404" class="method-detail">
- <a name="M000404"></a>
-
- <div class="method-heading">
- <a href="#M000404" class="method-signature">
- <span class="method-name">check_capabilities</span><span class="method-args">(filter)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-<a href="Agent.html">Agent</a> filters are always present no matter what,
-so we cant raise an error if the capabilities suggest the discovery method
-cant do agents we just have to rely on the discovery plugin to not do
-stupid things in the presense of a agent filter
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000404-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000404-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 62</span>
-62: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check_capabilities</span>(<span class="ruby-identifier">filter</span>)
-63: <span class="ruby-identifier">capabilities</span> = <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">discovery_interface</span>[<span class="ruby-identifier">:capabilities</span>]
-64:
-65: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">capabilities</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:classes</span>)
-66: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Cannot use class filters while using the '%s' discovery method"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">discovery_method</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"cf_class"</span>].<span class="ruby-identifier">empty?</span>
-67: <span class="ruby-keyword kw">end</span>
-68:
-69: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">capabilities</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:facts</span>)
-70: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Cannot use fact filters while using the '%s' discovery method"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">discovery_method</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"fact"</span>].<span class="ruby-identifier">empty?</span>
-71: <span class="ruby-keyword kw">end</span>
-72:
-73: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">capabilities</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:identity</span>)
-74: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Cannot use identity filters while using the '%s' discovery method"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">discovery_method</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"identity"</span>].<span class="ruby-identifier">empty?</span>
-75: <span class="ruby-keyword kw">end</span>
-76:
-77: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">capabilities</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:compound</span>)
-78: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Cannot use compound filters while using the '%s' discovery method"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">discovery_method</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"compound"</span>].<span class="ruby-identifier">empty?</span>
-79: <span class="ruby-keyword kw">end</span>
-80: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000403" class="method-detail">
- <a name="M000403"></a>
-
- <div class="method-heading">
- <a href="#M000403" class="method-signature">
- <span class="method-name">ddl</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000403-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000403-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 47</span>
-47: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ddl</span>
-48: <span class="ruby-ivar">@ddl</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">discovery_method</span>, <span class="ruby-identifier">:discovery</span>)
-49:
-50: <span class="ruby-comment cmt"># if the discovery method got changed we might have an old DDL cached</span>
-51: <span class="ruby-comment cmt"># this will detect that and reread the correct DDL from disk</span>
-52: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:name</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">discovery_method</span>
-53: <span class="ruby-ivar">@ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">discovery_method</span>, <span class="ruby-identifier">:discovery</span>)
-54: <span class="ruby-keyword kw">end</span>
-55:
-56: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@ddl</span>
-57: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000408" class="method-detail">
- <a name="M000408"></a>
-
- <div class="method-heading">
- <a href="#M000408" class="method-signature">
- <span class="method-name">discover</span><span class="method-args">(filter, timeout, limit)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000408-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000408-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 127</span>
-127: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discover</span>(<span class="ruby-identifier">filter</span>, <span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">limit</span>)
-128: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Limit has to be an integer"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">limit</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Fixnum</span>)
-129:
-130: <span class="ruby-identifier">force_discovery_method_by_filter</span>(<span class="ruby-identifier">filter</span>)
-131:
-132: <span class="ruby-identifier">check_capabilities</span>(<span class="ruby-identifier">filter</span>)
-133:
-134: <span class="ruby-identifier">discovered</span> = <span class="ruby-identifier">discovery_class</span>.<span class="ruby-identifier">discover</span>(<span class="ruby-identifier">filter</span>, <span class="ruby-identifier">discovery_timeout</span>(<span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">filter</span>), <span class="ruby-identifier">limit</span>, <span class="ruby-ivar">@client</span>)
-135:
-136: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">limit</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
-137: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">discovered</span>[<span class="ruby-value">0</span>,<span class="ruby-identifier">limit</span>]
-138: <span class="ruby-keyword kw">else</span>
-139: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">discovered</span>
-140: <span class="ruby-keyword kw">end</span>
-141: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000402" class="method-detail">
- <a name="M000402"></a>
-
- <div class="method-heading">
- <a href="#M000402" class="method-signature">
- <span class="method-name">discovery_class</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000402-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000402-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 39</span>
-39: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_class</span>
-40: <span class="ruby-identifier">method</span> = <span class="ruby-identifier">discovery_method</span>.<span class="ruby-identifier">capitalize</span>
-41:
-42: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">"MCollective::Discovery::#{method}"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-identifier">method</span>)
-43:
-44: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">method</span>)
-45: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000401" class="method-detail">
- <a name="M000401"></a>
-
- <div class="method-heading">
- <a href="#M000401" class="method-signature">
- <span class="method-name">discovery_method</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000401-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000401-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 21</span>
-21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_method</span>
-22: <span class="ruby-identifier">method</span> = <span class="ruby-value str">"mc"</span>
-23:
-24: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:discovery_method</span>]
-25: <span class="ruby-identifier">method</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:discovery_method</span>]
-26: <span class="ruby-keyword kw">else</span>
-27: <span class="ruby-identifier">method</span> = <span class="ruby-ivar">@default_method</span>
-28: <span class="ruby-keyword kw">end</span>
-29:
-30: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Unknown discovery method %s"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">method</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">has_method?</span>(<span class="ruby-identifier">method</span>)
-31:
-32: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">method</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"mc"</span>
-33: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Custom discovery methods require direct addressing mode"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">direct_addressing</span>
-34: <span class="ruby-keyword kw">end</span>
-35:
-36: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">method</span>
-37: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000407" class="method-detail">
- <a name="M000407"></a>
-
- <div class="method-heading">
- <a href="#M000407" class="method-signature">
- <span class="method-name">discovery_timeout</span><span class="method-args">(timeout, filter)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000407-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000407-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 117</span>
-117: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_timeout</span>(<span class="ruby-identifier">timeout</span>, <span class="ruby-identifier">filter</span>)
-118: <span class="ruby-identifier">timeout</span> = <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:timeout</span>] <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">timeout</span>
-119:
-120: <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">filter</span>[<span class="ruby-value str">"compound"</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"compound"</span>].<span class="ruby-identifier">empty?</span>)
-121: <span class="ruby-identifier">timeout</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">timeout_for_compound_filter</span>(<span class="ruby-identifier">filter</span>[<span class="ruby-value str">"compound"</span>])
-122: <span class="ruby-keyword kw">else</span>
-123: <span class="ruby-identifier">timeout</span>
-124: <span class="ruby-keyword kw">end</span>
-125: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000398" class="method-detail">
- <a name="M000398"></a>
-
- <div class="method-heading">
- <a href="#M000398" class="method-signature">
- <span class="method-name">find_known_methods</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000398-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000398-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 9</span>
- 9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">find_known_methods</span>
-10: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find</span>(<span class="ruby-value str">"discovery"</span>)
-11: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000400" class="method-detail">
- <a name="M000400"></a>
-
- <div class="method-heading">
- <a href="#M000400" class="method-signature">
- <span class="method-name">force_direct_mode?</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000400-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000400-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 17</span>
-17: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">force_direct_mode?</span>
-18: <span class="ruby-identifier">discovery_method</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">"mc"</span>
-19: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000405" class="method-detail">
- <a name="M000405"></a>
-
- <div class="method-heading">
- <a href="#M000405" class="method-signature">
- <span class="method-name">force_discovery_method_by_filter</span><span class="method-args">(filter)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-checks if compound filters are used and then forces the ‘mc’
-discovery plugin
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000405-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000405-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 83</span>
-83: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">force_discovery_method_by_filter</span>(<span class="ruby-identifier">filter</span>)
-84: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">discovery_method</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"mc"</span>
-85: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"compound"</span>].<span class="ruby-identifier">empty?</span>
-86: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">"Switching to mc discovery method because compound filters are used"</span>
-87: <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:discovery_method</span>] = <span class="ruby-value str">"mc"</span>
-88:
-89: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-90: <span class="ruby-keyword kw">end</span>
-91: <span class="ruby-keyword kw">end</span>
-92:
-93: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
-94: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000399" class="method-detail">
- <a name="M000399"></a>
-
- <div class="method-heading">
- <a href="#M000399" class="method-signature">
- <span class="method-name">has_method?</span><span class="method-args">(method)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000399-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000399-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 13</span>
-13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_method?</span>(<span class="ruby-identifier">method</span>)
-14: <span class="ruby-ivar">@known_methods</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">method</span>)
-15: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000406" class="method-detail">
- <a name="M000406"></a>
-
- <div class="method-heading">
- <a href="#M000406" class="method-signature">
- <span class="method-name">timeout_for_compound_filter</span><span class="method-args">(compound_filter)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-if a compound filter is specified and it has any function then we read the
-<a href="DDL.html">DDL</a> for each of those plugins and sum up the timeout
-declared in the <a href="DDL.html">DDL</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000406-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000406-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/discovery.rb, line 99</span>
- 99: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">timeout_for_compound_filter</span>(<span class="ruby-identifier">compound_filter</span>)
-100: <span class="ruby-keyword kw">return</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">compound_filter</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">compound_filter</span>.<span class="ruby-identifier">empty?</span>
-101:
-102: <span class="ruby-identifier">timeout</span> = <span class="ruby-value">0</span>
-103:
-104: <span class="ruby-identifier">compound_filter</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">filter</span><span class="ruby-operator">|</span>
-105: <span class="ruby-identifier">filter</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">statement</span><span class="ruby-operator">|</span>
-106: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>]
-107: <span class="ruby-identifier">pluginname</span> = <span class="ruby-constant">Data</span>.<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>][<span class="ruby-value str">"name"</span>])
-108: <span class="ruby-identifier">ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pluginname</span>, <span class="ruby-identifier">:data</span>)
-109: <span class="ruby-identifier">timeout</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:timeout</span>]
-110: <span class="ruby-keyword kw">end</span>
-111: <span class="ruby-keyword kw">end</span>
-112: <span class="ruby-keyword kw">end</span>
-113:
-114: <span class="ruby-identifier">timeout</span>
-115: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::Facts</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Facts</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/facts/base_rb.html">
- lib/mcollective/facts/base.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/facts_rb.html">
- lib/mcollective/facts.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-This is a class that gives access to the configured fact provider such as
-MCollectives::Facts::Facter that uses Reductive Labs facter
-</p>
-<p>
-The actual provider is pluggable and configurable using the
-‘factsource’ configuration option.
-</p>
-<p>
-To develop a new factsource simply create a class under <a
-href="Facts.html">MCollective::Facts</a>:: and provide the following
-classes:
-</p>
-<pre>
- self.get_fact(fact)
- self.has_fact?(fact)
-</pre>
-<p>
-You can also just inherit from <a
-href="Facts/Base.html">MCollective::Facts::Base</a> and provide just the
-</p>
-<pre>
- self.get_facts
-</pre>
-<p>
-method that should return a hash of facts.
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000018">[]</a>
- <a href="#M000017">get_fact</a>
- <a href="#M000016">has_fact?</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Class <a href="Facts/Base.html" class="link">MCollective::Facts::Base</a><br />
-
- </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000018" class="method-detail">
- <a name="M000018"></a>
-
- <div class="method-heading">
- <a href="#M000018" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(fact)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Get the value of a fact
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000018-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/facts.rb, line 35</span>
-35: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">fact</span>)
-36: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"facts_plugin"</span>].<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
-37: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000017" class="method-detail">
- <a name="M000017"></a>
-
- <div class="method-heading">
- <a href="#M000017" class="method-signature">
- <span class="method-name">get_fact</span><span class="method-args">(fact)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Get the value of a fact
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000017-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/facts.rb, line 30</span>
-30: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
-31: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"facts_plugin"</span>].<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
-32: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000016" class="method-detail">
- <a name="M000016"></a>
-
- <div class="method-heading">
- <a href="#M000016" class="method-signature">
- <span class="method-name">has_fact?</span><span class="method-args">(fact, value)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-True if we know of a specific fact else false
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000016-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/facts.rb, line 25</span>
-25: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_fact?</span>(<span class="ruby-identifier">fact</span>, <span class="ruby-identifier">value</span>)
-26: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"facts_plugin"</span>].<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>) <span class="ruby-operator">==</span> <span class="ruby-identifier">value</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">false</span>
-27: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Facts::Base</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Facts::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/facts/base_rb.html">
- lib/mcollective/facts/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A base class for fact providers, to make a <a
-href="Base.html#M000019">new</a> fully functional fact provider inherit
-from this and simply provide a self.get_facts method that returns a hash
-like:
-</p>
-<pre>
- {"foo" => "bar",
- "bar" => "baz"}
-</pre>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000024">force_reload?</a>
- <a href="#M000021">get_fact</a>
- <a href="#M000022">get_facts</a>
- <a href="#M000023">has_fact?</a>
- <a href="#M000020">inherited</a>
- <a href="#M000019">new</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000020" class="method-detail">
- <a name="M000020"></a>
-
- <div class="method-heading">
- <a href="#M000020" class="method-signature">
- <span class="method-name">inherited</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Registers <a href="Base.html#M000019">new</a> fact sources into the plugin
-manager
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000020-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 17</span>
-17: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
-18: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"facts_plugin"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>}
-19: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000019" class="method-detail">
- <a name="M000019"></a>
-
- <div class="method-heading">
- <a href="#M000019" class="method-signature">
- <span class="method-name">new</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000019-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 10</span>
-10: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
-11: <span class="ruby-ivar">@facts</span> = {}
-12: <span class="ruby-ivar">@last_good_facts</span> = {}
-13: <span class="ruby-ivar">@last_facts_load</span> = <span class="ruby-value">0</span>
-14: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000024" class="method-detail">
- <a name="M000024"></a>
-
- <div class="method-heading">
- <a href="#M000024" class="method-signature">
- <span class="method-name">force_reload?</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Plugins can override this to provide forced fact invalidation
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000024-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 81</span>
-81: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">force_reload?</span>
-82: <span class="ruby-keyword kw">false</span>
-83: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000021" class="method-detail">
- <a name="M000021"></a>
-
- <div class="method-heading">
- <a href="#M000021" class="method-signature">
- <span class="method-name">get_fact</span><span class="method-args">(fact=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns the value of a single fact
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000021-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 22</span>
-22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>=<span class="ruby-keyword kw">nil</span>)
-23: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
-24:
-25: <span class="ruby-identifier">cache_time</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">fact_cache_time</span> <span class="ruby-operator">||</span> <span class="ruby-value">300</span>
-26:
-27: <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">exclusive</span> <span class="ruby-keyword kw">do</span>
-28: <span class="ruby-keyword kw">begin</span>
-29: <span class="ruby-keyword kw">if</span> (<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@last_facts_load</span> <span class="ruby-operator">></span> <span class="ruby-identifier">cache_time</span>.<span class="ruby-identifier">to_i</span> ) <span class="ruby-operator">||</span> <span class="ruby-identifier">force_reload?</span>
-30: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Resetting facter cache, now: #{Time.now.to_i} last-known-good: #{@last_facts_load}"</span>)
-31:
-32: <span class="ruby-identifier">tfacts</span> = <span class="ruby-identifier">load_facts_from_source</span>
-33:
-34: <span class="ruby-comment cmt"># Force reset to last known good state on empty facts</span>
-35: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Got empty facts"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">tfacts</span>.<span class="ruby-identifier">empty?</span>
-36:
-37: <span class="ruby-ivar">@facts</span>.<span class="ruby-identifier">clear</span>
-38:
-39: <span class="ruby-identifier">tfacts</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>,<span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
-40: <span class="ruby-ivar">@facts</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">to_s</span>
-41: <span class="ruby-keyword kw">end</span>
-42:
-43: <span class="ruby-ivar">@last_good_facts</span> = <span class="ruby-ivar">@facts</span>.<span class="ruby-identifier">clone</span>
-44: <span class="ruby-ivar">@last_facts_load</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>
-45: <span class="ruby-keyword kw">else</span>
-46: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Using cached facts now: #{Time.now.to_i} last-known-good: #{@last_facts_load}"</span>)
-47: <span class="ruby-keyword kw">end</span>
-48: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-49: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Failed to load facts: #{e.class}: #{e}"</span>)
-50:
-51: <span class="ruby-comment cmt"># Avoid loops where failing fact loads cause huge CPU</span>
-52: <span class="ruby-comment cmt"># loops, this way it only retries once every cache_time</span>
-53: <span class="ruby-comment cmt"># seconds</span>
-54: <span class="ruby-ivar">@last_facts_load</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>
-55:
-56: <span class="ruby-comment cmt"># Revert to last known good state</span>
-57: <span class="ruby-ivar">@facts</span> = <span class="ruby-ivar">@last_good_facts</span>.<span class="ruby-identifier">clone</span>
-58: <span class="ruby-keyword kw">end</span>
-59: <span class="ruby-keyword kw">end</span>
-60:
-61:
-62: <span class="ruby-comment cmt"># If you do not supply a specific fact all facts will be returned</span>
-63: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">fact</span>.<span class="ruby-identifier">nil?</span>
-64: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@facts</span>
-65: <span class="ruby-keyword kw">else</span>
-66: <span class="ruby-ivar">@facts</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">fact</span>) <span class="ruby-operator">?</span> <span class="ruby-ivar">@facts</span>[<span class="ruby-identifier">fact</span>] <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>
-67: <span class="ruby-keyword kw">end</span>
-68: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000022" class="method-detail">
- <a name="M000022"></a>
-
- <div class="method-heading">
- <a href="#M000022" class="method-signature">
- <span class="method-name">get_facts</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns all facts
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000022-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 71</span>
-71: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_facts</span>
-72: <span class="ruby-identifier">get_fact</span>(<span class="ruby-keyword kw">nil</span>)
-73: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000023" class="method-detail">
- <a name="M000023"></a>
-
- <div class="method-heading">
- <a href="#M000023" class="method-signature">
- <span class="method-name">has_fact?</span><span class="method-args">(fact)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns true if we know about a specific fact, false otherwise
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000023-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/facts/base.rb, line 76</span>
-76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_fact?</span>(<span class="ruby-identifier">fact</span>)
-77: <span class="ruby-identifier">get_fact</span>(<span class="ruby-keyword kw">nil</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">fact</span>)
-78: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::Generators</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Generators</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/generators/base_rb.html">
- lib/mcollective/generators/base.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/generators/data_generator_rb.html">
- lib/mcollective/generators/data_generator.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/generators/agent_generator_rb.html">
- lib/mcollective/generators/agent_generator.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/generators_rb.html">
- lib/mcollective/generators.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Class <a href="Generators/AgentGenerator.html" class="link">MCollective::Generators::AgentGenerator</a><br />
-Class <a href="Generators/Base.html" class="link">MCollective::Generators::Base</a><br />
-Class <a href="Generators/DataGenerator.html" class="link">MCollective::Generators::DataGenerator</a><br />
-
- </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Generators::AgentGenerator</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Generators::AgentGenerator</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/generators/agent_generator_rb.html">
- lib/mcollective/generators/agent_generator.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000252">action_help</a>
- <a href="#M000250">create_ddl</a>
- <a href="#M000251">create_plugin_content</a>
- <a href="#M000249">new</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">content</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ddl</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000249" class="method-detail">
- <a name="M000249"></a>
-
- <div class="method-heading">
- <a href="#M000249" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(plugin_name, actions = [], name = nil, description = nil, author = nil , license = nil, version = nil, url = nil, timeout = nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000249-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000249-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/agent_generator.rb, line 7</span>
- 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">plugin_name</span>, <span class="ruby-identifier">actions</span> = [], <span class="ruby-identifier">name</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">description</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">author</span> = <span class="ruby-keyword kw">nil</span> ,
- 8: <span class="ruby-identifier">license</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">version</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">url</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">timeout</span> = <span class="ruby-keyword kw">nil</span>)
- 9:
-10: <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">description</span>, <span class="ruby-identifier">author</span>, <span class="ruby-identifier">license</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">timeout</span>)
-11: <span class="ruby-ivar">@plugin_name</span> = <span class="ruby-identifier">plugin_name</span>
-12: <span class="ruby-ivar">@actions</span> = <span class="ruby-identifier">actions</span> <span class="ruby-operator">||</span> []
-13: <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">create_ddl</span>
-14: <span class="ruby-ivar">@mod_name</span> = <span class="ruby-value str">"Agent"</span>
-15: <span class="ruby-ivar">@pclass</span> = <span class="ruby-value str">"RPC::Agent"</span>
-16: <span class="ruby-ivar">@content</span> = <span class="ruby-identifier">create_plugin_content</span>
-17: <span class="ruby-ivar">@plugin</span> = <span class="ruby-identifier">create_plugin_string</span>
-18: <span class="ruby-identifier">write_plugins</span>
-19: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000252" class="method-detail">
- <a name="M000252"></a>
-
- <div class="method-heading">
- <a href="#M000252" class="method-signature">
- <span class="method-name">action_help</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000252-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000252-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/agent_generator.rb, line 45</span>
-45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">action_help</span>
-46: <span class="ruby-identifier">action_snippet</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">"templates"</span>, <span class="ruby-value str">"action_snippet.erb"</span>))
-47: <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">action_snippet</span>).<span class="ruby-identifier">result</span>
-48: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000250" class="method-detail">
- <a name="M000250"></a>
-
- <div class="method-heading">
- <a href="#M000250" class="method-signature">
- <span class="method-name">create_ddl</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000250-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000250-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/agent_generator.rb, line 21</span>
-21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_ddl</span>
-22: <span class="ruby-identifier">action_text</span> = <span class="ruby-value str">""</span>
-23: <span class="ruby-ivar">@actions</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">action</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
-24: <span class="ruby-identifier">action_text</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"action \"#{action}\", :description => \"%ACTIONDESCRIPTION%\" do\n"</span>
-25: <span class="ruby-identifier">action_text</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">action_help</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
-26: <span class="ruby-identifier">action_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"end\n"</span>
-27: <span class="ruby-identifier">action_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@actions</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> (<span class="ruby-identifier">i</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
-28: <span class="ruby-keyword kw">end</span>
-29: <span class="ruby-comment cmt"># Use inherited method to create metadata part of the ddl</span>
-30: <span class="ruby-identifier">create_metadata_string</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">action_text</span>
-31: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000251" class="method-detail">
- <a name="M000251"></a>
-
- <div class="method-heading">
- <a href="#M000251" class="method-signature">
- <span class="method-name">create_plugin_content</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000251-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000251-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/agent_generator.rb, line 33</span>
-33: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_plugin_content</span>
-34: <span class="ruby-identifier">content_text</span> = <span class="ruby-value str">""</span>
-35:
-36: <span class="ruby-comment cmt"># Add actions to agent file</span>
-37: <span class="ruby-ivar">@actions</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">action</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
-38: <span class="ruby-identifier">content_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%6s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-node">"action \"#{action}\" do\n"</span>]
-39: <span class="ruby-identifier">content_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%6s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-value str">"end\n"</span>]
-40: <span class="ruby-identifier">content_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@actions</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> (<span class="ruby-identifier">i</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
-41: <span class="ruby-keyword kw">end</span>
-42: <span class="ruby-identifier">content_text</span>
-43: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Generators::Base</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Generators::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/generators/base_rb.html">
- lib/mcollective/generators/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000257">create_metadata_string</a>
- <a href="#M000258">create_plugin_string</a>
- <a href="#M000256">new</a>
- <a href="#M000259">write_plugins</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">meta</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">mod_name</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">plugin_name</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000256" class="method-detail">
- <a name="M000256"></a>
-
- <div class="method-heading">
- <a href="#M000256" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(name, description, author, license, version, url, timeout)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000256-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000256-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 5</span>
- 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">description</span>, <span class="ruby-identifier">author</span>, <span class="ruby-identifier">license</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">timeout</span>)
- 6: <span class="ruby-ivar">@meta</span> = {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>,
- 7: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">description</span>,
- 8: <span class="ruby-identifier">:author</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">author</span>,
- 9: <span class="ruby-identifier">:license</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">license</span>,
-10: <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">version</span>,
-11: <span class="ruby-identifier">:url</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">url</span>,
-12: <span class="ruby-identifier">:timeout</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">timeout</span>}
-13: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000257" class="method-detail">
- <a name="M000257"></a>
-
- <div class="method-heading">
- <a href="#M000257" class="method-signature">
- <span class="method-name">create_metadata_string</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000257-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000257-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 15</span>
-15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_metadata_string</span>
-16: <span class="ruby-identifier">ddl_template</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">"templates"</span>, <span class="ruby-value str">"ddl.erb"</span>))
-17: <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">ddl_template</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-value str">"-"</span>).<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>)
-18: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000258" class="method-detail">
- <a name="M000258"></a>
-
- <div class="method-heading">
- <a href="#M000258" class="method-signature">
- <span class="method-name">create_plugin_string</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000258-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000258-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 20</span>
-20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_plugin_string</span>
-21: <span class="ruby-identifier">plugin_template</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">"templates"</span>, <span class="ruby-value str">"plugin.erb"</span>))
-22: <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">plugin_template</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-value str">"-"</span>).<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>)
-23: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000259" class="method-detail">
- <a name="M000259"></a>
-
- <div class="method-heading">
- <a href="#M000259" class="method-signature">
- <span class="method-name">write_plugins</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000259-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000259-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 25</span>
-25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write_plugins</span>
-26: <span class="ruby-keyword kw">begin</span>
-27: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span> <span class="ruby-ivar">@plugin_name</span>
-28: <span class="ruby-identifier">dirname</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@plugin_name</span>, <span class="ruby-ivar">@mod_name</span>.<span class="ruby-identifier">downcase</span>)
-29: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span> <span class="ruby-identifier">dirname</span>
-30: <span class="ruby-identifier">puts</span> <span class="ruby-node">"Created plugin directory : #{@plugin_name}"</span>
-31:
-32: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">dirname</span>, <span class="ruby-node">"#{@plugin_name}.ddl"</span>), <span class="ruby-value str">"w"</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@ddl</span>}
-33: <span class="ruby-identifier">puts</span> <span class="ruby-node">"Created DDL file : #{File.join(dirname, "#{@plugin_name}.ddl")}"</span>
-34:
-35: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">dirname</span>, <span class="ruby-node">"#{@plugin_name}.rb"</span>), <span class="ruby-value str">"w"</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@plugin</span>}
-36: <span class="ruby-identifier">puts</span> <span class="ruby-node">"Created #{@mod_name} file : #{File.join(dirname, "#{@plugin_name}.rb")}"</span>
-37: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EEXIST</span>
-38: <span class="ruby-identifier">raise</span> <span class="ruby-node">"cannot generate '#{@plugin_name}' : plugin directory already exists."</span>
-39: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-40: <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span>(<span class="ruby-ivar">@plugin_name</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-ivar">@plugin_name</span>)
-41: <span class="ruby-identifier">raise</span> <span class="ruby-node">"cannot generate plugin - #{e}"</span>
-42: <span class="ruby-keyword kw">end</span>
-43: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Generators::DataGenerator</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Generators::DataGenerator</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/generators/data_generator_rb.html">
- lib/mcollective/generators/data_generator.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000254">create_ddl</a>
- <a href="#M000255">create_plugin_content</a>
- <a href="#M000253">new</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">content</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ddl</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000253" class="method-detail">
- <a name="M000253"></a>
-
- <div class="method-heading">
- <a href="#M000253" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(plugin_name, outputs = [], name = nil, description = nil, author = nil , license = nil, version = nil, url = nil, timeout = nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000253-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000253-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/data_generator.rb, line 7</span>
- 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">plugin_name</span>, <span class="ruby-identifier">outputs</span> = [], <span class="ruby-identifier">name</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">description</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">author</span> = <span class="ruby-keyword kw">nil</span> ,
- 8: <span class="ruby-identifier">license</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">version</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">url</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">timeout</span> = <span class="ruby-keyword kw">nil</span>)
- 9:
-10: <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">description</span>, <span class="ruby-identifier">author</span>, <span class="ruby-identifier">license</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">timeout</span>)
-11: <span class="ruby-ivar">@mod_name</span> = <span class="ruby-value str">"Data"</span>
-12: <span class="ruby-ivar">@pclass</span> = <span class="ruby-value str">"Base"</span>
-13: <span class="ruby-ivar">@plugin_name</span> = <span class="ruby-identifier">plugin_name</span>
-14: <span class="ruby-ivar">@outputs</span> = <span class="ruby-identifier">outputs</span>
-15: <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">create_ddl</span>
-16: <span class="ruby-ivar">@content</span> = <span class="ruby-identifier">create_plugin_content</span>
-17: <span class="ruby-ivar">@plugin</span> = <span class="ruby-identifier">create_plugin_string</span>
-18: <span class="ruby-identifier">write_plugins</span>
-19: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000254" class="method-detail">
- <a name="M000254"></a>
-
- <div class="method-heading">
- <a href="#M000254" class="method-signature">
- <span class="method-name">create_ddl</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000254-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000254-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/data_generator.rb, line 21</span>
-21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_ddl</span>
-22: <span class="ruby-identifier">query_text</span> = <span class="ruby-value str">"dataquery :description => \"Query information\" do\n"</span>
-23: <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">"templates"</span>, <span class="ruby-value str">"data_input_snippet.erb"</span>))).<span class="ruby-identifier">result</span>
-24:
-25: <span class="ruby-ivar">@outputs</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span>,<span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
-26: <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%2s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-node">"output :#{output},\n"</span>]
-27: <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%9s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-value str">":description => \"%DESCRIPTION%\",\n"</span>]
-28: <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%9s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-value str">":display_as => \"%DESCRIPTION%\"\n"</span>]
-29: <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@outputs</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> (<span class="ruby-identifier">i</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
-30: <span class="ruby-keyword kw">end</span>
-31:
-32: <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"end"</span>
-33:
-34: <span class="ruby-comment cmt"># Use inherited method to create metadata part of the ddl</span>
-35: <span class="ruby-identifier">create_metadata_string</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">query_text</span>
-36: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000255" class="method-detail">
- <a name="M000255"></a>
-
- <div class="method-heading">
- <a href="#M000255" class="method-signature">
- <span class="method-name">create_plugin_content</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000255-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000255-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/data_generator.rb, line 38</span>
-38: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_plugin_content</span>
-39: <span class="ruby-identifier">content_text</span> = <span class="ruby-value str">"%6s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-value str">"query do |what|\n"</span>]
-40:
-41: <span class="ruby-ivar">@outputs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span><span class="ruby-operator">|</span>
-42: <span class="ruby-identifier">content_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%8s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-node">"result[:#{output}] = nil\n"</span>]
-43: <span class="ruby-keyword kw">end</span>
-44: <span class="ruby-identifier">content_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"%6s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">" "</span>, <span class="ruby-value str">"end\n"</span>]
-45:
-46: <span class="ruby-comment cmt"># Add actions to agent file</span>
-47: <span class="ruby-identifier">content_text</span>
-48: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::InvalidRPCData</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::InvalidRPCData</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="RPCError.html">
- RPCError
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Log</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Log</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/log_rb.html">
- lib/mcollective/log.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A simple class that allows logging at various levels.
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000440">check_level</a>
- <a href="#M000439">config_and_check_level</a>
- <a href="#M000447">configure</a>
- <a href="#M000438">cycle_level</a>
- <a href="#M000434">debug</a>
- <a href="#M000436">error</a>
- <a href="#M000450">execution_stack</a>
- <a href="#M000435">fatal</a>
- <a href="#M000449">from</a>
- <a href="#M000432">info</a>
- <a href="#M000437">instance</a>
- <a href="#M000445">log</a>
- <a href="#M000443">logexception</a>
- <a href="#M000431">logger</a>
- <a href="#M000444">logmsg</a>
- <a href="#M000442">message_for</a>
- <a href="#M000446">set_logger</a>
- <a href="#M000448">unconfigure</a>
- <a href="#M000441">valid_level?</a>
- <a href="#M000433">warn</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
- <div id="constants-list">
- <h3 class="section-bar">Constants</h3>
-
- <div class="name-list">
- <table summary="Constants">
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">VALID_LEVELS</td>
- <td>=</td>
- <td class="context-item-value">[:error, :fatal, :debug, :warn, :info]</td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000440" class="method-detail">
- <a name="M000440"></a>
-
- <div class="method-heading">
- <a href="#M000440" class="method-signature">
- <span class="method-name">check_level</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000440-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000440-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 55</span>
-55: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check_level</span>(<span class="ruby-identifier">level</span>)
-56: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Unknown log level"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">valid_level?</span>(<span class="ruby-identifier">level</span>)
-57: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000439" class="method-detail">
- <a name="M000439"></a>
-
- <div class="method-heading">
- <a href="#M000439" class="method-signature">
- <span class="method-name">config_and_check_level</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000439-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000439-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 49</span>
-49: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">config_and_check_level</span>(<span class="ruby-identifier">level</span>)
-50: <span class="ruby-identifier">configure</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@configured</span>
-51: <span class="ruby-identifier">check_level</span>(<span class="ruby-identifier">level</span>)
-52: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">should_log?</span>(<span class="ruby-identifier">level</span>)
-53: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000447" class="method-detail">
- <a name="M000447"></a>
-
- <div class="method-heading">
- <a href="#M000447" class="method-signature">
- <span class="method-name">configure</span><span class="method-args">(logger=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-configures the <a href="Log.html#M000431">logger</a> class, if the config
-has not yet been loaded we default to the console logging class and do not
-set @configured so that future calls to the <a
-href="Log.html#M000445">log</a> method will keep attempting to <a
-href="Log.html#M000447">configure</a> the <a
-href="Log.html#M000431">logger</a> till we eventually get a logging
-preference <a href="Log.html#M000449">from</a> the config module
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000447-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000447-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 130</span>
-130: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure</span>(<span class="ruby-identifier">logger</span>=<span class="ruby-keyword kw">nil</span>)
-131: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">logger</span>
-132: <span class="ruby-identifier">logger_type</span> = <span class="ruby-value str">"console"</span>
-133:
-134: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
-135:
-136: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">configured</span>
-137: <span class="ruby-identifier">logger_type</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">logger_type</span>
-138: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">true</span>
-139: <span class="ruby-keyword kw">end</span>
-140:
-141: <span class="ruby-identifier">require</span> <span class="ruby-value str">"mcollective/logger/%s_logger"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">logger_type</span>.<span class="ruby-identifier">downcase</span>
-142:
-143: <span class="ruby-identifier">logger_class</span> = <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">Logger</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-value str">"%s_logger"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">logger_type</span>.<span class="ruby-identifier">capitalize</span>)
-144:
-145: <span class="ruby-identifier">set_logger</span>(<span class="ruby-identifier">logger_class</span>.<span class="ruby-identifier">new</span>)
-146: <span class="ruby-keyword kw">else</span>
-147: <span class="ruby-identifier">set_logger</span>(<span class="ruby-identifier">logger</span>)
-148: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">true</span>
-149: <span class="ruby-keyword kw">end</span>
-150:
-151:
-152: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">start</span>
-153: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-154: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">false</span>
-155: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Could not start logger: #{e.class} #{e}"</span>
-156: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000438" class="method-detail">
- <a name="M000438"></a>
-
- <div class="method-heading">
- <a href="#M000438" class="method-signature">
- <span class="method-name">cycle_level</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-increments the active <a href="Log.html#M000445">log</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000438-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000438-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 45</span>
-45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cycle_level</span>
-46: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">cycle_level</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@configured</span>
-47: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000434" class="method-detail">
- <a name="M000434"></a>
-
- <div class="method-heading">
- <a href="#M000434" class="method-signature">
- <span class="method-name">debug</span><span class="method-args">(msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Logs at <a href="Log.html#M000434">debug</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000434-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000434-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 25</span>
-25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">debug</span>(<span class="ruby-identifier">msg</span>)
-26: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">msg</span>)
-27: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000436" class="method-detail">
- <a name="M000436"></a>
-
- <div class="method-heading">
- <a href="#M000436" class="method-signature">
- <span class="method-name">error</span><span class="method-args">(msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Logs at <a href="Log.html#M000436">error</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000436-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000436-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 35</span>
-35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">error</span>(<span class="ruby-identifier">msg</span>)
-36: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:error</span>, <span class="ruby-identifier">msg</span>)
-37: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000450" class="method-detail">
- <a name="M000450"></a>
-
- <div class="method-heading">
- <a href="#M000450" class="method-signature">
- <span class="method-name">execution_stack</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-this method is here to facilitate testing
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000450-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000450-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 170</span>
-170: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execution_stack</span>
-171: <span class="ruby-identifier">caller</span>
-172: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000435" class="method-detail">
- <a name="M000435"></a>
-
- <div class="method-heading">
- <a href="#M000435" class="method-signature">
- <span class="method-name">fatal</span><span class="method-args">(msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Logs at <a href="Log.html#M000435">fatal</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000435-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000435-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 30</span>
-30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fatal</span>(<span class="ruby-identifier">msg</span>)
-31: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:fatal</span>, <span class="ruby-identifier">msg</span>)
-32: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000449" class="method-detail">
- <a name="M000449"></a>
-
- <div class="method-heading">
- <a href="#M000449" class="method-signature">
- <span class="method-name">from</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-figures out the filename that called us
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000449-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000449-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 164</span>
-164: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">from</span>
-165: <span class="ruby-identifier">path</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">method</span> = <span class="ruby-identifier">execution_stack</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/:(\d+)/</span>)
-166: <span class="ruby-value str">"%s:%s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">path</span>), <span class="ruby-identifier">line</span>, <span class="ruby-identifier">method</span>]
-167: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000432" class="method-detail">
- <a name="M000432"></a>
-
- <div class="method-heading">
- <a href="#M000432" class="method-signature">
- <span class="method-name">info</span><span class="method-args">(msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Logs at <a href="Log.html#M000432">info</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000432-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000432-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 15</span>
-15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">info</span>(<span class="ruby-identifier">msg</span>)
-16: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:info</span>, <span class="ruby-identifier">msg</span>)
-17: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000437" class="method-detail">
- <a name="M000437"></a>
-
- <div class="method-heading">
- <a href="#M000437" class="method-signature">
- <span class="method-name">instance</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-handle old code that relied on this class being a singleton
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000437-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000437-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 40</span>
-40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">instance</span>
-41: <span class="ruby-keyword kw">self</span>
-42: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000445" class="method-detail">
- <a name="M000445"></a>
-
- <div class="method-heading">
- <a href="#M000445" class="method-signature">
- <span class="method-name">log</span><span class="method-args">(level, msg, origin=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-logs a message at a certain level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000445-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000445-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 106</span>
-106: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">origin</span>=<span class="ruby-keyword kw">nil</span>)
-107: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config_and_check_level</span>(<span class="ruby-identifier">level</span>)
-108:
-109: <span class="ruby-identifier">origin</span> = <span class="ruby-identifier">from</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">origin</span>
-110:
-111: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@logger</span>
-112: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">origin</span>, <span class="ruby-identifier">msg</span>)
-113: <span class="ruby-keyword kw">else</span>
-114: <span class="ruby-identifier">t</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">"%H:%M:%S"</span>)
-115:
-116: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"#{t}: #{level}: #{origin}: #{msg}"</span>
-117: <span class="ruby-keyword kw">end</span>
-118: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000443" class="method-detail">
- <a name="M000443"></a>
-
- <div class="method-heading">
- <a href="#M000443" class="method-signature">
- <span class="method-name">logexception</span><span class="method-args">(msgid, level, e, backtrace=false, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000443-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000443-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 67</span>
-67: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">e</span>, <span class="ruby-identifier">backtrace</span>=<span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">args</span>={})
-68: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config_and_check_level</span>(<span class="ruby-identifier">level</span>)
-69:
-70: <span class="ruby-identifier">path</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">method</span> = <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/:(\d+)/</span>)
-71: <span class="ruby-identifier">origin</span> = <span class="ruby-value str">"%s:%s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">path</span>), <span class="ruby-identifier">line</span>, <span class="ruby-identifier">method</span>]
-72:
-73: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">CodedError</span>)
-74: <span class="ruby-identifier">msg</span> = <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">code</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>]
-75: <span class="ruby-keyword kw">else</span>
-76: <span class="ruby-identifier">error_string</span> = <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>]
-77: <span class="ruby-identifier">msg</span> = <span class="ruby-identifier">message_for</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">error_string</span>))
-78: <span class="ruby-keyword kw">end</span>
-79:
-80: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">origin</span>)
-81:
-82: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">backtrace</span>
-83: <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
-84: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">line</span>], <span class="ruby-identifier">origin</span>)
-85: <span class="ruby-keyword kw">end</span>
-86: <span class="ruby-keyword kw">end</span>
-87: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000431" class="method-detail">
- <a name="M000431"></a>
-
- <div class="method-heading">
- <a href="#M000431" class="method-signature">
- <span class="method-name">logger</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Obtain the class name of the currently configured <a
-href="Log.html#M000431">logger</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000431-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000431-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 10</span>
-10: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logger</span>
-11: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">class</span>
-12: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000444" class="method-detail">
- <a name="M000444"></a>
-
- <div class="method-heading">
- <a href="#M000444" class="method-signature">
- <span class="method-name">logmsg</span><span class="method-args">(msgid, default, level, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Logs a message at a certain level, the message must be a token that will be
-looked up <a href="Log.html#M000449">from</a> the i18n localization
-database
-</p>
-<p>
-Messages can interprolate strings <a href="Log.html#M000449">from</a> the
-args hash, a message with "foo %{bar}" in the localization
-database will use args[:bar] for the value there, the interprolation is
-handled by the i18n library itself
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000444-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000444-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 97</span>
- 97: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logmsg</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>={})
- 98: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config_and_check_level</span>(<span class="ruby-identifier">level</span>)
- 99:
-100: <span class="ruby-identifier">msg</span> = <span class="ruby-identifier">message_for</span>(<span class="ruby-identifier">msgid</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))
-101:
-102: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>)
-103: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000442" class="method-detail">
- <a name="M000442"></a>
-
- <div class="method-heading">
- <a href="#M000442" class="method-signature">
- <span class="method-name">message_for</span><span class="method-args">(msgid, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000442-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000442-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 63</span>
-63: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">message_for</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>={})
-64: <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">msgid</span>, <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>)]
-65: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000446" class="method-detail">
- <a name="M000446"></a>
-
- <div class="method-heading">
- <a href="#M000446" class="method-signature">
- <span class="method-name">set_logger</span><span class="method-args">(logger)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-sets the <a href="Log.html#M000431">logger</a> class to use
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000446-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000446-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 121</span>
-121: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logger</span>(<span class="ruby-identifier">logger</span>)
-122: <span class="ruby-ivar">@logger</span> = <span class="ruby-identifier">logger</span>
-123: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000448" class="method-detail">
- <a name="M000448"></a>
-
- <div class="method-heading">
- <a href="#M000448" class="method-signature">
- <span class="method-name">unconfigure</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000448-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000448-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 158</span>
-158: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unconfigure</span>
-159: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">false</span>
-160: <span class="ruby-identifier">set_logger</span>(<span class="ruby-keyword kw">nil</span>)
-161: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000441" class="method-detail">
- <a name="M000441"></a>
-
- <div class="method-heading">
- <a href="#M000441" class="method-signature">
- <span class="method-name">valid_level?</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000441-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000441-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 59</span>
-59: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_level?</span>(<span class="ruby-identifier">level</span>)
-60: <span class="ruby-constant">VALID_LEVELS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">level</span>)
-61: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000433" class="method-detail">
- <a name="M000433"></a>
-
- <div class="method-heading">
- <a href="#M000433" class="method-signature">
- <span class="method-name">warn</span><span class="method-args">(msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Logs at <a href="Log.html#M000433">warn</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000433-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000433-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 20</span>
-20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">warn</span>(<span class="ruby-identifier">msg</span>)
-21: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">msg</span>)
-22: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::Logger</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Logger</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/logger_rb.html">
- lib/mcollective/logger.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/logger/console_logger_rb.html">
- lib/mcollective/logger/console_logger.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/logger/base_rb.html">
- lib/mcollective/logger/base.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/logger/syslog_logger_rb.html">
- lib/mcollective/logger/syslog_logger.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/logger/file_logger_rb.html">
- lib/mcollective/logger/file_logger.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Class <a href="Logger/Base.html" class="link">MCollective::Logger::Base</a><br />
-Class <a href="Logger/Console_logger.html" class="link">MCollective::Logger::Console_logger</a><br />
-Class <a href="Logger/File_logger.html" class="link">MCollective::Logger::File_logger</a><br />
-Class <a href="Logger/Syslog_logger.html" class="link">MCollective::Logger::Syslog_logger</a><br />
-
- </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Logger::Base</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Logger::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/logger/base_rb.html">
- lib/mcollective/logger/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A base class for logging providers.
-</p>
-<p>
-Logging providers should provide the following:
-</p>
-<pre>
- * start - all you need to do to setup your logging
- * set_logging_level - set your logging to :info, :warn, etc
- * valid_levels - a hash of maps from :info to your internal level name
- * log - what needs to be done to log a specific message
-</pre>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000204">cycle_level</a>
- <a href="#M000202">new</a>
- <a href="#M000205">set_level</a>
- <a href="#M000203">should_log?</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">active_level</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000202" class="method-detail">
- <a name="M000202"></a>
-
- <div class="method-heading">
- <a href="#M000202" class="method-signature">
- <span class="method-name">new</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000202-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000202-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 14</span>
-14: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
-15: <span class="ruby-ivar">@known_levels</span> = [<span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:info</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:fatal</span>]
-16:
-17: <span class="ruby-comment cmt"># Sanity check the class that impliments the logging</span>
-18: <span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">lvl</span><span class="ruby-operator">|</span>
-19: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Logger class did not specify a map for #{lvl}"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">valid_levels</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">lvl</span>)
-20: <span class="ruby-keyword kw">end</span>
-21: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000204" class="method-detail">
- <a name="M000204"></a>
-
- <div class="method-heading">
- <a href="#M000204" class="method-signature">
- <span class="method-name">cycle_level</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Figures out the next level and sets it
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000204-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000204-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 28</span>
-28: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cycle_level</span>
-29: <span class="ruby-identifier">lvl</span> = <span class="ruby-identifier">get_next_level</span>
-30: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">lvl</span>)
-31:
-32: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">lvl</span>, <span class="ruby-value str">""</span>, <span class="ruby-node">"Logging level is now #{lvl.to_s.upcase}"</span>)
-33: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000205" class="method-detail">
- <a name="M000205"></a>
-
- <div class="method-heading">
- <a href="#M000205" class="method-signature">
- <span class="method-name">set_level</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets a <a href="Base.html#M000202">new</a> level and record it in
-@active_level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000205-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000205-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 36</span>
-36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">level</span>)
-37: <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
-38: <span class="ruby-ivar">@active_level</span> = <span class="ruby-identifier">level</span>.<span class="ruby-identifier">to_sym</span>
-39: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000203" class="method-detail">
- <a name="M000203"></a>
-
- <div class="method-heading">
- <a href="#M000203" class="method-signature">
- <span class="method-name">should_log?</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000203-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000203-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/base.rb, line 23</span>
-23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">should_log?</span>(<span class="ruby-identifier">level</span>)
-24: <span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">level</span>) <span class="ruby-operator">>=</span> <span class="ruby-ivar">@known_levels</span>.<span class="ruby-identifier">index</span>(<span class="ruby-ivar">@active_level</span>)
-25: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Logger::Console_logger</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Logger::Console_logger</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/logger/console_logger_rb.html">
- lib/mcollective/logger/console_logger.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Implements a syslog based logger using the standard ruby syslog class
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000210">color</a>
- <a href="#M000211">colorize</a>
- <a href="#M000209">log</a>
- <a href="#M000207">set_logging_level</a>
- <a href="#M000206">start</a>
- <a href="#M000208">valid_levels</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000210" class="method-detail">
- <a name="M000210"></a>
-
- <div class="method-heading">
- <a href="#M000210" class="method-signature">
- <span class="method-name">color</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Set some colors for various logging levels, will honor the <a
-href="Console_logger.html#M000210">color</a> configuration option and
-return nothing if its configured not to
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000210-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000210-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 37</span>
-37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">color</span>(<span class="ruby-identifier">level</span>)
-38: <span class="ruby-identifier">colorize</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">color</span>
-39:
-40: <span class="ruby-identifier">colors</span> = {<span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:red</span>),
-41: <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:red</span>),
-42: <span class="ruby-identifier">:warn</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:yellow</span>),
-43: <span class="ruby-identifier">:info</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:green</span>),
-44: <span class="ruby-identifier">:reset</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:reset</span>)}
-45:
-46: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">colorize</span>
-47: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">colors</span>[<span class="ruby-identifier">level</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">""</span>
-48: <span class="ruby-keyword kw">else</span>
-49: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span>
-50: <span class="ruby-keyword kw">end</span>
-51: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000211" class="method-detail">
- <a name="M000211"></a>
-
- <div class="method-heading">
- <a href="#M000211" class="method-signature">
- <span class="method-name">colorize</span><span class="method-args">(level, msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Helper to return a string in specific <a
-href="Console_logger.html#M000210">color</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000211-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000211-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 54</span>
-54: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>)
-55: <span class="ruby-value str">"%s%s%s"</span> <span class="ruby-operator">%</span> [ <span class="ruby-identifier">color</span>(<span class="ruby-identifier">level</span>), <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">color</span>(<span class="ruby-identifier">:reset</span>) ]
-56: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000209" class="method-detail">
- <a name="M000209"></a>
-
- <div class="method-heading">
- <a href="#M000209" class="method-signature">
- <span class="method-name">log</span><span class="method-args">(level, from, msg, normal_output=STDERR, last_resort_output=STDERR)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000209-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000209-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 24</span>
-24: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">normal_output</span>=<span class="ruby-constant">STDERR</span>, <span class="ruby-identifier">last_resort_output</span>=<span class="ruby-constant">STDERR</span>)
-25: <span class="ruby-identifier">time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">"%Y/%m/%d %H:%M:%S"</span>)
-26:
-27: <span class="ruby-identifier">normal_output</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-value str">"%s %s: %s %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">level</span>), <span class="ruby-identifier">time</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">msg</span>])
-28: <span class="ruby-keyword kw">rescue</span>
-29: <span class="ruby-comment cmt"># if this fails we probably cant show the user output at all,</span>
-30: <span class="ruby-comment cmt"># STDERR it as last resort</span>
-31: <span class="ruby-identifier">last_resort_output</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-node">"#{level}: #{msg}"</span>)
-32: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000207" class="method-detail">
- <a name="M000207"></a>
-
- <div class="method-heading">
- <a href="#M000207" class="method-signature">
- <span class="method-name">set_logging_level</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000207-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000207-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 12</span>
-12: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
-13: <span class="ruby-comment cmt"># nothing to do here, we ignore high levels when we log</span>
-14: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000206" class="method-detail">
- <a name="M000206"></a>
-
- <div class="method-heading">
- <a href="#M000206" class="method-signature">
- <span class="method-name">start</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000206-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000206-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 5</span>
- 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
- 6: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">:info</span>)
- 7:
- 8: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
- 9: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">loglevel</span>.<span class="ruby-identifier">to_sym</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">configured</span>
-10: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000208" class="method-detail">
- <a name="M000208"></a>
-
- <div class="method-heading">
- <a href="#M000208" class="method-signature">
- <span class="method-name">valid_levels</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000208-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000208-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 16</span>
-16: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_levels</span>
-17: {<span class="ruby-identifier">:info</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:info</span>,
-18: <span class="ruby-identifier">:warn</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:warning</span>,
-19: <span class="ruby-identifier">:debug</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:debug</span>,
-20: <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:crit</span>,
-21: <span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:err</span>}
-22: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Logger::File_logger</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Logger::File_logger</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/logger/file_logger_rb.html">
- lib/mcollective/logger/file_logger.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Impliments a file based logger using the standard ruby logger class
-</p>
-<p>
-To configure you should set:
-</p>
-<pre>
- - config.logfile
- - config.keeplogs defaults to 2097152
- - config.max_log_size defaults to 5
-</pre>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000215">log</a>
- <a href="#M000213">set_logging_level</a>
- <a href="#M000212">start</a>
- <a href="#M000214">valid_levels</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000215" class="method-detail">
- <a name="M000215"></a>
-
- <div class="method-heading">
- <a href="#M000215" class="method-signature">
- <span class="method-name">log</span><span class="method-args">(level, from, msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000215-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000215-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 37</span>
-37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">msg</span>)
-38: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">map_level</span>(<span class="ruby-identifier">level</span>)) { <span class="ruby-node">"#{from} #{msg}"</span> }
-39: <span class="ruby-keyword kw">rescue</span>
-40: <span class="ruby-comment cmt"># if this fails we probably cant show the user output at all,</span>
-41: <span class="ruby-comment cmt"># STDERR it as last resort</span>
-42: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-node">"#{level}: #{msg}"</span>)
-43: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000213" class="method-detail">
- <a name="M000213"></a>
-
- <div class="method-heading">
- <a href="#M000213" class="method-signature">
- <span class="method-name">set_logging_level</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000213-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000213-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 22</span>
-22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
-23: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">level</span> = <span class="ruby-identifier">map_level</span>(<span class="ruby-identifier">level</span>)
-24: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-25: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">level</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">DEBUG</span>
-26: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:error</span>, <span class="ruby-value str">""</span>, <span class="ruby-node">"Could not set logging to #{level} using debug instead: #{e.class} #{e}"</span>)
-27: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000212" class="method-detail">
- <a name="M000212"></a>
-
- <div class="method-heading">
- <a href="#M000212" class="method-signature">
- <span class="method-name">start</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000212-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000212-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 13</span>
-13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
-14: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
-15:
-16: <span class="ruby-ivar">@logger</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">logfile</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">keeplogs</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">max_log_size</span>)
-17: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">formatter</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">Formatter</span>.<span class="ruby-identifier">new</span>
-18:
-19: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">loglevel</span>.<span class="ruby-identifier">to_sym</span>)
-20: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000214" class="method-detail">
- <a name="M000214"></a>
-
- <div class="method-heading">
- <a href="#M000214" class="method-signature">
- <span class="method-name">valid_levels</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000214-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000214-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 29</span>
-29: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_levels</span>
-30: {<span class="ruby-identifier">:info</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">INFO</span>,
-31: <span class="ruby-identifier">:warn</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">WARN</span>,
-32: <span class="ruby-identifier">:debug</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">DEBUG</span>,
-33: <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">FATAL</span>,
-34: <span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">ERROR</span>}
-35: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Logger::Syslog_logger</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Logger::Syslog_logger</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/logger/syslog_logger_rb.html">
- lib/mcollective/logger/syslog_logger.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Implements a syslog based logger using the standard ruby syslog class
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000201">log</a>
- <a href="#M000199">set_logging_level</a>
- <a href="#M000197">start</a>
- <a href="#M000198">syslog_facility</a>
- <a href="#M000200">valid_levels</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
- <div id="includes">
- <h3 class="section-bar">Included Modules</h3>
-
- <div id="includes-list">
- <span class="include-name">Syslog::Constants</span>
- </div>
- </div>
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000201" class="method-detail">
- <a name="M000201"></a>
-
- <div class="method-heading">
- <a href="#M000201" class="method-signature">
- <span class="method-name">log</span><span class="method-args">(level, from, msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000201-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000201-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 42</span>
-42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">msg</span>)
-43: <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">map_level</span>(<span class="ruby-identifier">level</span>), <span class="ruby-node">"#{from} #{msg}"</span>)
-44: <span class="ruby-keyword kw">rescue</span>
-45: <span class="ruby-comment cmt"># if this fails we probably cant show the user output at all,</span>
-46: <span class="ruby-comment cmt"># STDERR it as last resort</span>
-47: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-node">"#{level}: #{msg}"</span>)
-48: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000199" class="method-detail">
- <a name="M000199"></a>
-
- <div class="method-heading">
- <a href="#M000199" class="method-signature">
- <span class="method-name">set_logging_level</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000199-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000199-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 30</span>
-30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
-31: <span class="ruby-comment cmt"># noop</span>
-32: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000197" class="method-detail">
- <a name="M000197"></a>
-
- <div class="method-heading">
- <a href="#M000197" class="method-signature">
- <span class="method-name">start</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000197-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000197-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 9</span>
- 9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
-10: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
-11:
-12: <span class="ruby-identifier">facility</span> = <span class="ruby-identifier">syslog_facility</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">logfacility</span>)
-13: <span class="ruby-identifier">level</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">loglevel</span>.<span class="ruby-identifier">to_sym</span>
-14:
-15: <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">opened?</span>
-16: <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">$0</span>), <span class="ruby-value">3</span>, <span class="ruby-identifier">facility</span>)
-17:
-18: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">level</span>)
-19: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000198" class="method-detail">
- <a name="M000198"></a>
-
- <div class="method-heading">
- <a href="#M000198" class="method-signature">
- <span class="method-name">syslog_facility</span><span class="method-args">(facility)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000198-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000198-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 21</span>
-21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">syslog_facility</span>(<span class="ruby-identifier">facility</span>)
-22: <span class="ruby-keyword kw">begin</span>
-23: <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-node">"LOG_#{facility.upcase}"</span>)
-24: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NameError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-25: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Invalid syslog facility #{facility} supplied, reverting to USER"</span>
-26: <span class="ruby-constant">Syslog</span><span class="ruby-operator">::</span><span class="ruby-constant">LOG_USER</span>
-27: <span class="ruby-keyword kw">end</span>
-28: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000200" class="method-detail">
- <a name="M000200"></a>
-
- <div class="method-heading">
- <a href="#M000200" class="method-signature">
- <span class="method-name">valid_levels</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000200-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000200-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 34</span>
-34: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_levels</span>
-35: {<span class="ruby-identifier">:info</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:info</span>,
-36: <span class="ruby-identifier">:warn</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:warning</span>,
-37: <span class="ruby-identifier">:debug</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:debug</span>,
-38: <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:crit</span>,
-39: <span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:err</span>}
-40: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Matcher::Scanner</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Matcher::Scanner</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/matcher/scanner_rb.html">
- lib/mcollective/matcher/scanner.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000154">get_token</a>
- <a href="#M000153">new</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">arguments</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">token_index</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000153" class="method-detail">
- <a name="M000153"></a>
-
- <div class="method-heading">
- <a href="#M000153" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(arguments)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000153-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000153-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/matcher/scanner.rb, line 6</span>
- 6: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">arguments</span>)
- 7: <span class="ruby-ivar">@token_index</span> = <span class="ruby-value">0</span>
- 8: <span class="ruby-ivar">@arguments</span> = <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">""</span>)
- 9: <span class="ruby-ivar">@seperation_counter</span> = <span class="ruby-value">0</span>
-10: <span class="ruby-ivar">@white_spaces</span> = <span class="ruby-value">0</span>
-11: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000154" class="method-detail">
- <a name="M000154"></a>
-
- <div class="method-heading">
- <a href="#M000154" class="method-signature">
- <span class="method-name">get_token</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Scans the input string and identifies single language tokens
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000154-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000154-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/matcher/scanner.rb, line 14</span>
-14: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_token</span>
-15: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">>=</span> <span class="ruby-ivar">@arguments</span>.<span class="ruby-identifier">size</span>
-16: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
-17: <span class="ruby-keyword kw">end</span>
-18:
-19: <span class="ruby-keyword kw">case</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span>]
-20: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"("</span>
-21: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"("</span>, <span class="ruby-value str">"("</span>
-22:
-23: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">")"</span>
-24: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">")"</span>, <span class="ruby-value str">")"</span>
-25:
-26: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"n"</span>
-27: <span class="ruby-keyword kw">if</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"o"</span>) <span class="ruby-operator">&&</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"t"</span>) <span class="ruby-operator">&&</span> ((<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">" "</span>) <span class="ruby-operator">||</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"("</span>))
-28: <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+=</span> <span class="ruby-value">2</span>
-29: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"not"</span>, <span class="ruby-value str">"not"</span>
-30: <span class="ruby-keyword kw">else</span>
-31: <span class="ruby-identifier">gen_statement</span>
-32: <span class="ruby-keyword kw">end</span>
-33:
-34: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"!"</span>
-35: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"not"</span>, <span class="ruby-value str">"not"</span>
-36:
-37: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"a"</span>
-38: <span class="ruby-keyword kw">if</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"n"</span>) <span class="ruby-operator">&&</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"d"</span>) <span class="ruby-operator">&&</span> ((<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">" "</span>) <span class="ruby-operator">||</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"("</span>))
-39: <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+=</span> <span class="ruby-value">2</span>
-40: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"and"</span>, <span class="ruby-value str">"and"</span>
-41: <span class="ruby-keyword kw">else</span>
-42: <span class="ruby-identifier">gen_statement</span>
-43: <span class="ruby-keyword kw">end</span>
-44:
-45: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"o"</span>
-46: <span class="ruby-keyword kw">if</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"r"</span>) <span class="ruby-operator">&&</span> ((<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">" "</span>) <span class="ruby-operator">||</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">"("</span>))
-47: <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
-48: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">"or"</span>, <span class="ruby-value str">"or"</span>
-49: <span class="ruby-keyword kw">else</span>
-50: <span class="ruby-identifier">gen_statement</span>
-51: <span class="ruby-keyword kw">end</span>
-52:
-53: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">" "</span>
-54: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">" "</span>, <span class="ruby-value str">" "</span>
-55:
-56: <span class="ruby-keyword kw">else</span>
-57: <span class="ruby-identifier">gen_statement</span>
-58: <span class="ruby-keyword kw">end</span>
-59: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Message</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Message</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/message_rb.html">
- lib/mcollective/message.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-container for a message, its headers, agent, collective and other meta data
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000338">base64?</a>
- <a href="#M000336">base64_decode!</a>
- <a href="#M000337">base64_encode!</a>
- <a href="#M000344">create_reqid</a>
- <a href="#M000341">decode!</a>
- <a href="#M000339">encode!</a>
- <a href="#M000335">expected_msgid=</a>
- <a href="#M000332">new</a>
- <a href="#M000343">publish</a>
- <a href="#M000334">reply_to=</a>
- <a href="#M000333">type=</a>
- <a href="#M000342">validate</a>
- <a href="#M000340">validate_compound_filter</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
- <div id="constants-list">
- <h3 class="section-bar">Constants</h3>
-
- <div class="name-list">
- <table summary="Constants">
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">VALIDTYPES</td>
- <td>=</td>
- <td class="context-item-value">[:message, :request, :direct_request, :reply]</td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">agent</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">collective</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">discovered_hosts</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">expected_msgid</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">filter</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">headers</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">message</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">msgtime</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">options</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">payload</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">reply_to</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">request</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">requestid</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ttl</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">type</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">validated</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000332" class="method-detail">
- <a name="M000332"></a>
-
- <div class="method-heading">
- <a href="#M000332" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(payload, message, options = {})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-payload - the message body without headers etc, just the text message - the
-original message received from the middleware options[:base64] - if the
-body base64 encoded? options[:agent] - the agent the message is for/from
-options[:collective] - the collective its for/from options[:headers] - the
-message headers options[:type] - an indicator about the type of message,
-:message, :request, :direct_request or :reply options[:request] - if this
-is a reply this should old the message we are replying to options[:filter]
-- for requests, the filter to encode into the message options[:options] -
-the normal client options hash options[:ttl] - the maximum amount of
-seconds this message can be valid for options[:expected_msgid] - in the
-case of replies this is the msgid it is expecting in the replies
-options[:requestid] - specific request id to use else one will be generated
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000332-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000332-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 23</span>
-23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">payload</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">options</span> = {})
-24: <span class="ruby-identifier">options</span> = {<span class="ruby-identifier">:base64</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>,
-25: <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>,
-26: <span class="ruby-identifier">:headers</span> =<span class="ruby-operator">></span> {},
-27: <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:message</span>,
-28: <span class="ruby-identifier">:request</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>,
-29: <span class="ruby-identifier">:filter</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter</span>,
-30: <span class="ruby-identifier">:options</span> =<span class="ruby-operator">></span> {},
-31: <span class="ruby-identifier">:ttl</span> =<span class="ruby-operator">></span> <span class="ruby-value">60</span>,
-32: <span class="ruby-identifier">:expected_msgid</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>,
-33: <span class="ruby-identifier">:requestid</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>,
-34: <span class="ruby-identifier">:collective</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>)
-35:
-36: <span class="ruby-ivar">@payload</span> = <span class="ruby-identifier">payload</span>
-37: <span class="ruby-ivar">@message</span> = <span class="ruby-identifier">message</span>
-38: <span class="ruby-ivar">@requestid</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:requestid</span>]
-39: <span class="ruby-ivar">@discovered_hosts</span> = <span class="ruby-keyword kw">nil</span>
-40: <span class="ruby-ivar">@reply_to</span> = <span class="ruby-keyword kw">nil</span>
-41:
-42: <span class="ruby-ivar">@type</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:type</span>]
-43: <span class="ruby-ivar">@headers</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:headers</span>]
-44: <span class="ruby-ivar">@base64</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:base64</span>]
-45: <span class="ruby-ivar">@filter</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:filter</span>]
-46: <span class="ruby-ivar">@expected_msgid</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:expected_msgid</span>]
-47: <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:options</span>]
-48:
-49: <span class="ruby-ivar">@ttl</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:ttl</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">ttl</span>
-50: <span class="ruby-ivar">@msgtime</span> = <span class="ruby-value">0</span>
-51:
-52: <span class="ruby-ivar">@validated</span> = <span class="ruby-keyword kw">false</span>
-53:
-54: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:request</span>]
-55: <span class="ruby-ivar">@request</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:request</span>]
-56: <span class="ruby-ivar">@agent</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">agent</span>
-57: <span class="ruby-ivar">@collective</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">collective</span>
-58: <span class="ruby-ivar">@type</span> = <span class="ruby-identifier">:reply</span>
-59: <span class="ruby-keyword kw">else</span>
-60: <span class="ruby-ivar">@agent</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:agent</span>]
-61: <span class="ruby-ivar">@collective</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:collective</span>]
-62: <span class="ruby-keyword kw">end</span>
-63:
-64: <span class="ruby-identifier">base64_decode!</span>
-65: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000338" class="method-detail">
- <a name="M000338"></a>
-
- <div class="method-heading">
- <a href="#M000338" class="method-signature">
- <span class="method-name">base64?</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000338-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000338-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 129</span>
-129: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">base64?</span>
-130: <span class="ruby-ivar">@base64</span>
-131: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000336" class="method-detail">
- <a name="M000336"></a>
-
- <div class="method-heading">
- <a href="#M000336" class="method-signature">
- <span class="method-name">base64_decode!</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000336-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000336-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 115</span>
-115: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">base64_decode!</span>
-116: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@base64</span>
-117:
-118: <span class="ruby-ivar">@payload</span> = <span class="ruby-constant">SSL</span>.<span class="ruby-identifier">base64_decode</span>(<span class="ruby-ivar">@payload</span>)
-119: <span class="ruby-ivar">@base64</span> = <span class="ruby-keyword kw">false</span>
-120: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000337" class="method-detail">
- <a name="M000337"></a>
-
- <div class="method-heading">
- <a href="#M000337" class="method-signature">
- <span class="method-name">base64_encode!</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000337-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000337-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 122</span>
-122: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">base64_encode!</span>
-123: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@base64</span>
-124:
-125: <span class="ruby-ivar">@payload</span> = <span class="ruby-constant">SSL</span>.<span class="ruby-identifier">base64_encode</span>(<span class="ruby-ivar">@payload</span>)
-126: <span class="ruby-ivar">@base64</span> = <span class="ruby-keyword kw">true</span>
-127: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000344" class="method-detail">
- <a name="M000344"></a>
-
- <div class="method-heading">
- <a href="#M000344" class="method-signature">
- <span class="method-name">create_reqid</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000344-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000344-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 226</span>
-226: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_reqid</span>
-227: <span class="ruby-comment cmt"># we gsub out the -s so that the format of the id does not</span>
-228: <span class="ruby-comment cmt"># change from previous versions, these should just be more</span>
-229: <span class="ruby-comment cmt"># unique than previous ones</span>
-230: <span class="ruby-constant">SSL</span>.<span class="ruby-identifier">uuid</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">"-"</span>, <span class="ruby-value str">""</span>)
-231: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000341" class="method-detail">
- <a name="M000341"></a>
-
- <div class="method-heading">
- <a href="#M000341" class="method-signature">
- <span class="method-name">decode!</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000341-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000341-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 175</span>
-175: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">decode!</span>
-176: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Cannot decode message type #{type}"</span> <span class="ruby-keyword kw">unless</span> [<span class="ruby-identifier">:request</span>, <span class="ruby-identifier">:reply</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">type</span>)
-177:
-178: <span class="ruby-ivar">@payload</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>].<span class="ruby-identifier">decodemsg</span>(<span class="ruby-keyword kw">self</span>)
-179:
-180: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:request</span>
-181: <span class="ruby-identifier">raise</span> <span class="ruby-value str">'callerid in request is not valid, surpressing reply to potentially forged request'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>].<span class="ruby-identifier">valid_callerid?</span>(<span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:callerid</span>])
-182: <span class="ruby-keyword kw">end</span>
-183:
-184: [<span class="ruby-identifier">:collective</span>, <span class="ruby-identifier">:agent</span>, <span class="ruby-identifier">:filter</span>, <span class="ruby-identifier">:requestid</span>, <span class="ruby-identifier">:ttl</span>, <span class="ruby-identifier">:msgtime</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">prop</span><span class="ruby-operator">|</span>
-185: <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">"@#{prop}"</span>, <span class="ruby-identifier">payload</span>[<span class="ruby-identifier">prop</span>]) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">prop</span>)
-186: <span class="ruby-keyword kw">end</span>
-187: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000339" class="method-detail">
- <a name="M000339"></a>
-
- <div class="method-heading">
- <a href="#M000339" class="method-signature">
- <span class="method-name">encode!</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000339-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000339-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 133</span>
-133: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">encode!</span>
-134: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">type</span>
-135: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:reply</span>
-136: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Cannot encode a reply message if no request has been associated with it"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">request</span>
-137: <span class="ruby-identifier">raise</span> <span class="ruby-value str">'callerid in original request is not valid, surpressing reply to potentially forged request'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>].<span class="ruby-identifier">valid_callerid?</span>(<span class="ruby-identifier">request</span>.<span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:callerid</span>])
-138:
-139: <span class="ruby-ivar">@requestid</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:requestid</span>]
-140: <span class="ruby-ivar">@payload</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>].<span class="ruby-identifier">encodereply</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">payload</span>, <span class="ruby-identifier">requestid</span>, <span class="ruby-identifier">request</span>.<span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:callerid</span>])
-141: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:request</span>, <span class="ruby-identifier">:direct_request</span>
-142: <span class="ruby-identifier">validate_compound_filter</span>(<span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"compound"</span>]) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"compound"</span>].<span class="ruby-identifier">empty?</span>
-143:
-144: <span class="ruby-ivar">@requestid</span> = <span class="ruby-identifier">create_reqid</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@requestid</span>
-145: <span class="ruby-ivar">@payload</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>].<span class="ruby-identifier">encoderequest</span>(<span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">identity</span>, <span class="ruby-identifier">payload</span>, <span class="ruby-identifier">requestid</span>, <span class="ruby-identifier">filter</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">collective</span>, <span class="ruby-identifier">ttl</span>)
-146: <span class="ruby-keyword kw">else</span>
-147: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Cannot encode #{type} messages"</span>
-148: <span class="ruby-keyword kw">end</span>
-149: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000335" class="method-detail">
- <a name="M000335"></a>
-
- <div class="method-heading">
- <a href="#M000335" class="method-signature">
- <span class="method-name">expected_msgid=</span><span class="method-args">(msgid)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-in the case of reply messages we are expecting replies to a previously
-created message. This stores a hint to that previously sent message id and
-can be used by other classes like the security plugins as a means of
-optimizing their behavior like by ignoring messages not directed at us.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000335-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000335-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 110</span>
-110: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">expected_msgid=</span>(<span class="ruby-identifier">msgid</span>)
-111: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Can only store the expected msgid for reply messages"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@type</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:reply</span>
-112: <span class="ruby-ivar">@expected_msgid</span> = <span class="ruby-identifier">msgid</span>
-113: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000343" class="method-detail">
- <a name="M000343"></a>
-
- <div class="method-heading">
- <a href="#M000343" class="method-signature">
- <span class="method-name">publish</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-<a href="Message.html#M000343">publish</a> a reply message by creating a
-target name and sending it
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000343-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000343-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 213</span>
-213: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">publish</span>
-214: <span class="ruby-comment cmt"># If we've been specificaly told about hosts that were discovered</span>
-215: <span class="ruby-comment cmt"># use that information to do P2P calls if appropriate else just</span>
-216: <span class="ruby-comment cmt"># send it as is.</span>
-217: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
-218: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@discovered_hosts</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">direct_addressing</span> <span class="ruby-operator">&&</span> (<span class="ruby-ivar">@discovered_hosts</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator"><=</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">direct_addressing_threshold</span>)
-219: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">type</span> = <span class="ruby-identifier">:direct_request</span>
-220: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Handling #{requestid} as a direct request"</span>)
-221: <span class="ruby-keyword kw">end</span>
-222:
-223: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">'connector_plugin'</span>].<span class="ruby-identifier">publish</span>(<span class="ruby-keyword kw">self</span>)
-224: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000334" class="method-detail">
- <a name="M000334"></a>
-
- <div class="method-heading">
- <a href="#M000334" class="method-signature">
- <span class="method-name">reply_to=</span><span class="method-args">(target)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets a custom reply-to target for requests. The connector plugin should
-inspect this when constructing requests and set this header ensuring
-replies will go to the custom target otherwise the connector should just do
-what it usually does
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000334-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000334-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 99</span>
- 99: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reply_to=</span>(<span class="ruby-identifier">target</span>)
-100: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Custom reply targets can only be set on requests"</span> <span class="ruby-keyword kw">unless</span> [<span class="ruby-identifier">:request</span>, <span class="ruby-identifier">:direct_request</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@type</span>)
-101:
-102: <span class="ruby-ivar">@reply_to</span> = <span class="ruby-identifier">target</span>
-103: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000333" class="method-detail">
- <a name="M000333"></a>
-
- <div class="method-heading">
- <a href="#M000333" class="method-signature">
- <span class="method-name">type=</span><span class="method-args">(type)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Sets the message type to one of the known types. In the case of
-:direct_request the list of hosts to communicate with should have been set
-with discovered_hosts else an exception will be raised. This is for extra
-security, we never accidentally want to send a direct request without a
-list of hosts or something weird like that as it might result in a
-filterless broadcast being sent.
-</p>
-<p>
-Additionally you simply cannot set :direct_request if direct_addressing was
-not enabled this is to force a workflow that doesnt not yield in a mistake
-when someone might assume direct_addressing is enabled when its not.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000333-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000333-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 76</span>
-76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">type=</span>(<span class="ruby-identifier">type</span>)
-77: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Unknown message type #{type}"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">VALIDTYPES</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">type</span>)
-78:
-79: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:direct_request</span>
-80: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Direct requests is not enabled using the direct_addressing config option"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">direct_addressing</span>
-81:
-82: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@discovered_hosts</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@discovered_hosts</span>.<span class="ruby-identifier">empty?</span>
-83: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Can only set type to :direct_request if discovered_hosts have been set"</span>
-84: <span class="ruby-keyword kw">end</span>
-85:
-86: <span class="ruby-comment cmt"># clear out the filter, custom discovery sources might interpret the filters</span>
-87: <span class="ruby-comment cmt"># different than the remote mcollectived and in directed mode really the only</span>
-88: <span class="ruby-comment cmt"># filter that matters is the agent filter</span>
-89: <span class="ruby-ivar">@filter</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter</span>
-90: <span class="ruby-ivar">@filter</span>[<span class="ruby-value str">"agent"</span>] <span class="ruby-operator"><<</span> <span class="ruby-ivar">@agent</span>
-91: <span class="ruby-keyword kw">end</span>
-92:
-93: <span class="ruby-ivar">@type</span> = <span class="ruby-identifier">type</span>
-94: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000342" class="method-detail">
- <a name="M000342"></a>
-
- <div class="method-heading">
- <a href="#M000342" class="method-signature">
- <span class="method-name">validate</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Perform validation against the message by checking filters and ttl
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000342-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000342-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 190</span>
-190: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate</span>
-191: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Can only validate request messages"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:request</span>
-192:
-193: <span class="ruby-identifier">msg_age</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">utc</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">msgtime</span>
-194:
-195: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">msg_age</span> <span class="ruby-operator">></span> <span class="ruby-identifier">ttl</span>
-196: <span class="ruby-identifier">cid</span> = <span class="ruby-value str">""</span>
-197: <span class="ruby-identifier">cid</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:callerid</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">"@"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:callerid</span>)
-198: <span class="ruby-identifier">cid</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:senderid</span>]
-199:
-200: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">msg_age</span> <span class="ruby-operator">></span> <span class="ruby-identifier">ttl</span>
-201: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"global_stats"</span>].<span class="ruby-identifier">ttlexpired</span>
-202:
-203: <span class="ruby-identifier">raise</span>(<span class="ruby-constant">MsgTTLExpired</span>, <span class="ruby-node">"message #{requestid} from #{cid} created at #{msgtime} is #{msg_age} seconds old, TTL is #{ttl}"</span>)
-204: <span class="ruby-keyword kw">end</span>
-205: <span class="ruby-keyword kw">end</span>
-206:
-207: <span class="ruby-identifier">raise</span>(<span class="ruby-constant">NotTargettedAtUs</span>, <span class="ruby-value str">"Received message is not targetted to us"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>].<span class="ruby-identifier">validate_filter?</span>(<span class="ruby-identifier">payload</span>[<span class="ruby-identifier">:filter</span>])
-208:
-209: <span class="ruby-ivar">@validated</span> = <span class="ruby-keyword kw">true</span>
-210: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000340" class="method-detail">
- <a name="M000340"></a>
-
- <div class="method-heading">
- <a href="#M000340" class="method-signature">
- <span class="method-name">validate_compound_filter</span><span class="method-args">(compound_filter)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000340-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000340-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/message.rb, line 151</span>
-151: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_compound_filter</span>(<span class="ruby-identifier">compound_filter</span>)
-152: <span class="ruby-identifier">compound_filter</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">filter</span><span class="ruby-operator">|</span>
-153: <span class="ruby-identifier">filter</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">statement</span><span class="ruby-operator">|</span>
-154: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>]
-155: <span class="ruby-identifier">functionname</span> = <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>][<span class="ruby-value str">"name"</span>]
-156: <span class="ruby-identifier">pluginname</span> = <span class="ruby-constant">Data</span>.<span class="ruby-identifier">pluginname</span>(<span class="ruby-identifier">functionname</span>)
-157: <span class="ruby-identifier">value</span> = <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>][<span class="ruby-value str">"value"</span>]
-158:
-159: <span class="ruby-identifier">ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pluginname</span>, <span class="ruby-identifier">:data</span>)
-160:
-161: <span class="ruby-comment cmt"># parses numbers and booleans entered as strings into proper</span>
-162: <span class="ruby-comment cmt"># types of data so that DDL validation will pass</span>
-163: <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>][<span class="ruby-value str">"params"</span>] = <span class="ruby-constant">Data</span>.<span class="ruby-identifier">ddl_transform_input</span>(<span class="ruby-identifier">ddl</span>, <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>][<span class="ruby-value str">"params"</span>])
-164:
-165: <span class="ruby-constant">Data</span>.<span class="ruby-identifier">ddl_validate</span>(<span class="ruby-identifier">ddl</span>, <span class="ruby-identifier">statement</span>[<span class="ruby-value str">"fstatement"</span>][<span class="ruby-value str">"params"</span>])
-166:
-167: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">Data</span>.<span class="ruby-identifier">ddl_has_output?</span>(<span class="ruby-identifier">ddl</span>, <span class="ruby-identifier">value</span>)
-168: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC41</span>, <span class="ruby-value str">"Data plugin '%{functionname}()' does not return a '%{value}' value"</span>, <span class="ruby-identifier">:error</span>, {<span class="ruby-identifier">:functionname</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">functionname</span>, <span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">value</span>})
-169: <span class="ruby-keyword kw">end</span>
-170: <span class="ruby-keyword kw">end</span>
-171: <span class="ruby-keyword kw">end</span>
-172: <span class="ruby-keyword kw">end</span>
-173: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::MissingRPCData</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::MissingRPCData</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="RPCError.html">
- RPCError
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::MsgDoesNotMatchRequestID</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::MsgDoesNotMatchRequestID</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- RuntimeError
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::MsgTTLExpired</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::MsgTTLExpired</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- RuntimeError
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::NotTargettedAtUs</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::NotTargettedAtUs</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- RuntimeError
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::PluginManager</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::PluginManager</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/pluginmanager_rb.html">
- lib/mcollective/pluginmanager.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A simple plugin manager, it stores one plugin each of a specific type the
-idea is that we can only have one security provider, one connector etc.
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000025"><<</a>
- <a href="#M000030">[]</a>
- <a href="#M000029">clear</a>
- <a href="#M000031">create_instance</a>
- <a href="#M000026">delete</a>
- <a href="#M000032">find</a>
- <a href="#M000033">find_and_load</a>
- <a href="#M000035">grep</a>
- <a href="#M000027">include?</a>
- <a href="#M000034">loadclass</a>
- <a href="#M000028">pluginlist</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000025" class="method-detail">
- <a name="M000025"></a>
-
- <div class="method-heading">
- <a href="#M000025" class="method-signature">
- <span class="method-name"><<</span><span class="method-args">(plugin)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Adds a plugin to the list of plugins, we expect a hash like:
-</p>
-<pre>
- {:type => "base",
- :class => foo.new}
-</pre>
-<p>
-or like:
-</p>
-<pre>
- {:type => "base",
- :class => "Foo::Bar"}
-</pre>
-<p>
-In the event that we already have a class with the given type an exception
-will be raised.
-</p>
-<p>
-If the :class passed is a <a href="../String.html">String</a> then we will
-delay instantiation till the first time someone asks for the plugin, this
-is because most likely the registration gets done by inherited() hooks, at
-which point the plugin class is not final.
-</p>
-<p>
-If we were to do a .new here the Class initialize method would get called
-and not the plugins, we there for only initialize the classes when they get
-requested via []
-</p>
-<p>
-By default all plugin instances are cached and returned later so
-there‘s always a single instance. You can pass :single_instance =>
-false when calling this to instruct it to always return a new instance when
-a copy is requested. This only works with sending a <a
-href="../String.html">String</a> for :class.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000025-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000025-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 30</span>
-30: <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>)
-31: <span class="ruby-identifier">plugin</span>[<span class="ruby-identifier">:single_instance</span>] = <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:single_instance</span>)
-32:
-33: <span class="ruby-identifier">type</span> = <span class="ruby-identifier">plugin</span>[<span class="ruby-identifier">:type</span>]
-34: <span class="ruby-identifier">klass</span> = <span class="ruby-identifier">plugin</span>[<span class="ruby-identifier">:class</span>]
-35: <span class="ruby-identifier">single</span> = <span class="ruby-identifier">plugin</span>[<span class="ruby-identifier">:single_instance</span>]
-36:
-37: <span class="ruby-identifier">raise</span>(<span class="ruby-node">"Plugin #{type} already loaded"</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">type</span>)
-38:
-39:
-40: <span class="ruby-comment cmt"># If we get a string then store 'nil' as the instance, signalling that we'll</span>
-41: <span class="ruby-comment cmt"># create the class later on demand.</span>
-42: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
-43: <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">type</span>] = {<span class="ruby-identifier">:loadtime</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>, <span class="ruby-identifier">:instance</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">:single</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">single</span>}
-44: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Registering plugin #{type} with class #{klass} single_instance: #{single}"</span>)
-45: <span class="ruby-keyword kw">else</span>
-46: <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">type</span>] = {<span class="ruby-identifier">:loadtime</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">:instance</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>, <span class="ruby-identifier">:single</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>}
-47: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Registering plugin #{type} with class #{klass.class} single_instance: true"</span>)
-48: <span class="ruby-keyword kw">end</span>
-49: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000030" class="method-detail">
- <a name="M000030"></a>
-
- <div class="method-heading">
- <a href="#M000030" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(plugin)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Gets a plugin by type
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000030-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000030-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 72</span>
-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>)
-73: <span class="ruby-identifier">raise</span>(<span class="ruby-node">"No plugin #{plugin} defined"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">plugin</span>)
-74:
-75: <span class="ruby-identifier">klass</span> = <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">plugin</span>][<span class="ruby-identifier">:class</span>]
-76:
-77: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">plugin</span>][<span class="ruby-identifier">:single</span>]
-78: <span class="ruby-comment cmt"># Create an instance of the class if one hasn't been done before</span>
-79: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">plugin</span>][<span class="ruby-identifier">:instance</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
-80: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Returning new plugin #{plugin} with class #{klass}"</span>)
-81: <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">plugin</span>][<span class="ruby-identifier">:instance</span>] = <span class="ruby-identifier">create_instance</span>(<span class="ruby-identifier">klass</span>)
-82: <span class="ruby-keyword kw">else</span>
-83: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Returning cached plugin #{plugin} with class #{klass}"</span>)
-84: <span class="ruby-keyword kw">end</span>
-85:
-86: <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">plugin</span>][<span class="ruby-identifier">:instance</span>]
-87: <span class="ruby-keyword kw">else</span>
-88: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Returning new plugin #{plugin} with class #{klass}"</span>)
-89: <span class="ruby-identifier">create_instance</span>(<span class="ruby-identifier">klass</span>)
-90: <span class="ruby-keyword kw">end</span>
-91: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000029" class="method-detail">
- <a name="M000029"></a>
-
- <div class="method-heading">
- <a href="#M000029" class="method-signature">
- <span class="method-name">clear</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-deletes all registered plugins
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000029-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000029-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 67</span>
-67: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">clear</span>
-68: <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">clear</span>
-69: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000031" class="method-detail">
- <a name="M000031"></a>
-
- <div class="method-heading">
- <a href="#M000031" class="method-signature">
- <span class="method-name">create_instance</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-use eval to create an instance of a class
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000031-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000031-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 94</span>
- 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>)
- 95: <span class="ruby-keyword kw">begin</span>
- 96: <span class="ruby-identifier">eval</span>(<span class="ruby-node">"#{klass}.new"</span>)
- 97: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
- 98: <span class="ruby-identifier">raise</span>(<span class="ruby-node">"Could not create instance of plugin #{klass}: #{e}"</span>)
- 99: <span class="ruby-keyword kw">end</span>
-100: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000026" class="method-detail">
- <a name="M000026"></a>
-
- <div class="method-heading">
- <a href="#M000026" class="method-signature">
- <span class="method-name">delete</span><span class="method-args">(plugin)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Removes a plugim the list
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000026-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000026-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 52</span>
-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>)
-53: <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">plugin</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">plugin</span>)
-54: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000032" class="method-detail">
- <a name="M000032"></a>
-
- <div class="method-heading">
- <a href="#M000032" class="method-signature">
- <span class="method-name">find</span><span class="method-args">(type, extension="rb")</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Finds plugins in all configured libdirs
-</p>
-<pre>
- find("agent")
-</pre>
-<p>
-will return an array of just agent names, for example:
-</p>
-<pre>
- ["puppetd", "package"]
-</pre>
-<p>
-Can also be used to <a href="PluginManager.html#M000032">find</a> files of
-other extensions:
-</p>
-<pre>
- find("agent", "ddl")
-</pre>
-<p>
-Will return the same list but only of files with extension .ddl in the
-agent subdirectory
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000032-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000032-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 116</span>
-116: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">extension</span>=<span class="ruby-value str">"rb"</span>)
-117: <span class="ruby-identifier">extension</span> = <span class="ruby-node">".#{extension}"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">extension</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^\./</span>)
-118:
-119: <span class="ruby-identifier">plugins</span> = []
-120:
-121: <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">libdir</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">libdir</span><span class="ruby-operator">|</span>
-122: <span class="ruby-identifier">plugdir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>([<span class="ruby-identifier">libdir</span>, <span class="ruby-value str">"mcollective"</span>, <span class="ruby-identifier">type</span>.<span class="ruby-identifier">to_s</span>])
-123: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">plugdir</span>)
-124:
-125: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">plugdir</span>).<span class="ruby-identifier">grep</span>(<span class="ruby-node">/#{extension}$/</span>).<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">plugin</span><span class="ruby-operator">|</span>
-126: <span class="ruby-identifier">plugins</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">plugin</span>, <span class="ruby-identifier">extension</span>)
-127: <span class="ruby-keyword kw">end</span>
-128: <span class="ruby-keyword kw">end</span>
-129:
-130: <span class="ruby-identifier">plugins</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">uniq</span>
-131: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000033" class="method-detail">
- <a name="M000033"></a>
-
- <div class="method-heading">
- <a href="#M000033" class="method-signature">
- <span class="method-name">find_and_load</span><span class="method-args">(type, extension="rb") {|plugin| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Finds and loads from disk all plugins from all libdirs that match certain
-criteria.
-</p>
-<pre>
- find_and_load("pluginpackager")
-</pre>
-<p>
-Will <a href="PluginManager.html#M000032">find</a> all .rb files in the
-libdir/mcollective/pluginpackager/ directory in all libdirs and load them
-from disk.
-</p>
-<p>
-You can influence what plugins get loaded using a block notation:
-</p>
-<pre>
- find_and_load("pluginpackager") do |plugin|
- plugin.match(/puppet/)
- end
-</pre>
-<p>
-This will load only plugins matching /puppet/
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000033-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000033-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 148</span>
-148: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">find_and_load</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">extension</span>=<span class="ruby-value str">"rb"</span>)
-149: <span class="ruby-identifier">extension</span> = <span class="ruby-node">".#{extension}"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">extension</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^\./</span>)
-150:
-151: <span class="ruby-identifier">klasses</span> = <span class="ruby-identifier">find</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">extension</span>).<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">plugin</span><span class="ruby-operator">|</span>
-152: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-153: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">plugin</span>)
-154: <span class="ruby-keyword kw">end</span>
-155:
-156: <span class="ruby-value str">"%s::%s::%s"</span> <span class="ruby-operator">%</span> [ <span class="ruby-value str">"MCollective"</span>, <span class="ruby-identifier">type</span>.<span class="ruby-identifier">capitalize</span>, <span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">capitalize</span> ]
-157: <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">compact</span>
-158:
-159: <span class="ruby-identifier">klasses</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">uniq</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">klass</span><span class="ruby-operator">|</span> <span class="ruby-identifier">loadclass</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-keyword kw">true</span>)}
-160: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000035" class="method-detail">
- <a name="M000035"></a>
-
- <div class="method-heading">
- <a href="#M000035" class="method-signature">
- <span class="method-name">grep</span><span class="method-args">(regex)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Grep‘s over the plugin list and returns the list found
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000035-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000035-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 176</span>
-176: <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>)
-177: <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-identifier">regex</span>)
-178: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000027" class="method-detail">
- <a name="M000027"></a>
-
- <div class="method-heading">
- <a href="#M000027" class="method-signature">
- <span class="method-name">include?</span><span class="method-args">(plugin)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Finds out if we have a plugin with the given name
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000027-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000027-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 57</span>
-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>)
-58: <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">plugin</span>)
-59: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000034" class="method-detail">
- <a name="M000034"></a>
-
- <div class="method-heading">
- <a href="#M000034" class="method-signature">
- <span class="method-name">loadclass</span><span class="method-args">(klass, squash_failures=false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Loads a class from file by doing some simple search/replace on class names
-and then doing a require.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000034-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000034-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 164</span>
-164: <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>, <span class="ruby-identifier">squash_failures</span>=<span class="ruby-keyword kw">false</span>)
-165: <span class="ruby-identifier">fname</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">"::"</span>, <span class="ruby-value str">"/"</span>).<span class="ruby-identifier">downcase</span> <span class="ruby-operator">+</span> <span class="ruby-value str">".rb"</span>
-166:
-167: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Loading #{klass} from #{fname}"</span>)
-168:
-169: <span class="ruby-identifier">load</span> <span class="ruby-identifier">fname</span>
-170: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-171: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Failed to load #{klass}: #{e}"</span>)
-172: <span class="ruby-identifier">raise</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">squash_failures</span>
-173: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000028" class="method-detail">
- <a name="M000028"></a>
-
- <div class="method-heading">
- <a href="#M000028" class="method-signature">
- <span class="method-name">pluginlist</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Provides a list of plugins we know about
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000028-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000028-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginmanager.rb, line 62</span>
-62: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">pluginlist</span>
-63: <span class="ruby-ivar">@plugins</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">sort</span>
-64: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::PluginPackager</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::PluginPackager</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/pluginpackager_rb.html">
- lib/mcollective/pluginpackager.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/pluginpackager/standard_definition_rb.html">
- lib/mcollective/pluginpackager/standard_definition.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/pluginpackager/agent_definition_rb.html">
- lib/mcollective/pluginpackager/agent_definition.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000312">[]</a>
- <a href="#M000314">check_dir_present</a>
- <a href="#M000316">command_available?</a>
- <a href="#M000315">execute_verbosely</a>
- <a href="#M000318">filter_dependencies</a>
- <a href="#M000313">get_metadata</a>
- <a href="#M000311">load_packagers</a>
- <a href="#M000317">safe_system</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Class <a href="PluginPackager/AgentDefinition.html" class="link">MCollective::PluginPackager::AgentDefinition</a><br />
-Class <a href="PluginPackager/StandardDefinition.html" class="link">MCollective::PluginPackager::StandardDefinition</a><br />
-
- </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000312" class="method-detail">
- <a name="M000312"></a>
-
- <div class="method-heading">
- <a href="#M000312" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000312-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000312-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 12</span>
-12: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">klass</span>)
-13: <span class="ruby-identifier">const_get</span>(<span class="ruby-node">"#{klass}"</span>)
-14: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000314" class="method-detail">
- <a name="M000314"></a>
-
- <div class="method-heading">
- <a href="#M000314" class="method-signature">
- <span class="method-name">check_dir_present</span><span class="method-args">(path)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Checks if a directory is present and not empty
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000314-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000314-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 31</span>
-31: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">check_dir_present</span>(<span class="ruby-identifier">path</span>)
-32: (<span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">path</span>) <span class="ruby-operator">&&</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">path</span>, <span class="ruby-value str">"*"</span>)).<span class="ruby-identifier">empty?</span>)
-33: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000316" class="method-detail">
- <a name="M000316"></a>
-
- <div class="method-heading">
- <a href="#M000316" class="method-signature">
- <span class="method-name">command_available?</span><span class="method-args">(build_tool)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Checks if a build tool is present on the system
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000316-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000316-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 54</span>
-54: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">command_available?</span>(<span class="ruby-identifier">build_tool</span>)
-55: <span class="ruby-constant">ENV</span>[<span class="ruby-value str">"PATH"</span>].<span class="ruby-identifier">split</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">PATH_SEPARATOR</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
-56: <span class="ruby-identifier">builder</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">build_tool</span>)
-57: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">builder</span>)
-58: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-59: <span class="ruby-keyword kw">end</span>
-60: <span class="ruby-keyword kw">end</span>
-61: <span class="ruby-keyword kw">false</span>
-62: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000315" class="method-detail">
- <a name="M000315"></a>
-
- <div class="method-heading">
- <a href="#M000315" class="method-signature">
- <span class="method-name">execute_verbosely</span><span class="method-args">(verbose, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Quietly calls a block if verbose parameter is false
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000315-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000315-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 36</span>
-36: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">execute_verbosely</span>(<span class="ruby-identifier">verbose</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-37: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">verbose</span>
-38: <span class="ruby-identifier">old_stdout</span> = <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">clone</span>
-39: <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">"/dev/null"</span>, <span class="ruby-value str">"w"</span>))
-40: <span class="ruby-keyword kw">begin</span>
-41: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>
-42: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-43: <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">reopen</span> <span class="ruby-identifier">old_stdout</span>
-44: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
-45: <span class="ruby-keyword kw">ensure</span>
-46: <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">reopen</span> <span class="ruby-identifier">old_stdout</span>
-47: <span class="ruby-keyword kw">end</span>
-48: <span class="ruby-keyword kw">else</span>
-49: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>
-50: <span class="ruby-keyword kw">end</span>
-51: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000318" class="method-detail">
- <a name="M000318"></a>
-
- <div class="method-heading">
- <a href="#M000318" class="method-signature">
- <span class="method-name">filter_dependencies</span><span class="method-args">(prefix, dependencies)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Filter out platform specific dependencies Given a list of dependencies
-named - debian::foo redhat::bar <a
-href="PluginPackager.html#M000318">PluginPackager.filter_dependencies</a>(‘debian’,
-dependencies) will return foo.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000318-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000318-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 74</span>
-74: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">filter_dependencies</span>(<span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">dependencies</span>)
-75: <span class="ruby-identifier">dependencies</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dependency</span><span class="ruby-operator">|</span>
-76: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-identifier">:name</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^(\w+)::(\w+)/</span>
-77: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">prefix</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">$1</span>
-78: <span class="ruby-identifier">dependency</span>[<span class="ruby-identifier">:name</span>] = <span class="ruby-identifier">$2</span>
-79: <span class="ruby-identifier">dependency</span>
-80: <span class="ruby-keyword kw">else</span>
-81: <span class="ruby-keyword kw">nil</span>
-82: <span class="ruby-keyword kw">end</span>
-83: <span class="ruby-keyword kw">else</span>
-84: <span class="ruby-identifier">dependency</span>
-85: <span class="ruby-keyword kw">end</span>
-86: <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">reject</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">dependency</span><span class="ruby-operator">|</span> <span class="ruby-identifier">dependency</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span> }
-87: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000313" class="method-detail">
- <a name="M000313"></a>
-
- <div class="method-heading">
- <a href="#M000313" class="method-signature">
- <span class="method-name">get_metadata</span><span class="method-args">(path, type)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Fetch and return metadata from plugin <a href="DDL.html">DDL</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000313-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000313-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 17</span>
-17: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_metadata</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">type</span>)
-18: <span class="ruby-identifier">ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">"package"</span>, <span class="ruby-identifier">type</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-keyword kw">false</span>)
-19:
-20: <span class="ruby-keyword kw">begin</span>
-21: <span class="ruby-identifier">ddl_file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</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">path</span>, <span class="ruby-identifier">type</span>, <span class="ruby-value str">"*.ddl"</span>)).<span class="ruby-identifier">first</span>)
-22: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span>
-23: <span class="ruby-identifier">raise</span> <span class="ruby-node">"failed to load ddl file in plugin directory : #{File.join(path, type)}"</span>
-24: <span class="ruby-keyword kw">end</span>
-25: <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">instance_eval</span> <span class="ruby-identifier">ddl_file</span>
-26:
-27: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">meta</span>, <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">requirements</span>[<span class="ruby-identifier">:mcollective</span>]
-28: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000311" class="method-detail">
- <a name="M000311"></a>
-
- <div class="method-heading">
- <a href="#M000311" class="method-signature">
- <span class="method-name">load_packagers</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Package implementation plugins
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000311-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000311-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 8</span>
- 8: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_packagers</span>
- 9: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find_and_load</span>(<span class="ruby-value str">"pluginpackager"</span>)
-10: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000317" class="method-detail">
- <a name="M000317"></a>
-
- <div class="method-heading">
- <a href="#M000317" class="method-signature">
- <span class="method-name">safe_system</span><span class="method-args">(*args)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000317-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000317-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 64</span>
-64: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">safe_system</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
-65: <span class="ruby-identifier">raise</span>(<span class="ruby-constant">RuntimeError</span>, <span class="ruby-node">"Failed: #{args.join(' ')}"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">system</span> <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>
-66: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::PluginPackager::AgentDefinition</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::PluginPackager::AgentDefinition</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/pluginpackager/agent_definition_rb.html">
- lib/mcollective/pluginpackager/agent_definition.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-<a href="../../MCollective.html">MCollective</a> <a
-href="../Agent.html">Agent</a> Plugin package
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000325">agent</a>
- <a href="#M000326">client</a>
- <a href="#M000327">common</a>
- <a href="#M000324">identify_packages</a>
- <a href="#M000323">new</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">dependencies</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">mcname</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">mcversion</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">metadata</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">packagedata</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">path</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">plugintype</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">postinstall</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">preinstall</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">revision</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">target_path</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">vendor</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000323" class="method-detail">
- <a name="M000323"></a>
-
- <div class="method-heading">
- <a href="#M000323" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(configuration, mcdependency, plugintype)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000323-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000323-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">"Puppet Labs"</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">"agent"</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">"mcollective"</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"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{@mcname}-common"</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@mcversion</span>}
-23: <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:name</span>] = (<span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:pluginname</span>] <span class="ruby-operator">||</span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:name</span>]).<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/\s+|_/</span>, <span class="ruby-value str">"-"</span>)
-24: <span class="ruby-identifier">identify_packages</span>
-25: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000325" class="method-detail">
- <a name="M000325"></a>
-
- <div class="method-heading">
- <a href="#M000325" class="method-signature">
- <span class="method-name">agent</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Obtain <a href="../Agent.html">Agent</a> package files and dependencies.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000325-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000325-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">></span> [],
-40: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
-41: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"Agent plugin for #{@metadata[:name]}"</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">"agent"</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">"*.ddl"</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">"*"</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">></span> <span class="ruby-node">"#{@mcname}-#{@metadata[:name]}-common"</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>], <span class="ruby-identifier">:revision</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@revision</span>}
-52: <span class="ruby-identifier">agent</span>
-53: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000326" class="method-detail">
- <a name="M000326"></a>
-
- <div class="method-heading">
- <a href="#M000326" class="method-signature">
- <span class="method-name">client</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Obtain <a href="AgentDefinition.html#M000326">client</a> package files and
-dependencies.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000326-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000326-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">></span> [],
-58: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
-59: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"Client plugin for #{@metadata[:name]}"</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">"application"</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">"aggregate"</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">"*"</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">"*"</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">></span> <span class="ruby-node">"#{@mcname}-#{@metadata[:name]}-common"</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>], <span class="ruby-identifier">:revision</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@revision</span>}
-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="method-M000327" class="method-detail">
- <a name="M000327"></a>
-
- <div class="method-heading">
- <a href="#M000327" class="method-signature">
- <span class="method-name">common</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Obtain <a href="AgentDefinition.html#M000327">common</a> package files and
-dependencies.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000327-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000327-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">></span>[],
-73: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
-74: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"Common libraries for #{@metadata[:name]}"</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">"data"</span>, <span class="ruby-value str">"**"</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">"util"</span>, <span class="ruby-value str">"**"</span>, <span class="ruby-value str">"**"</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">"agent"</span>, <span class="ruby-value str">"*.ddl"</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">"validator"</span>, <span class="ruby-value str">"**"</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">"cannot create package - No ddl file found in #{File.join(@path, "agent")}"</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="method-M000324" class="method-detail">
- <a name="M000324"></a>
-
- <div class="method-heading">
- <a href="#M000324" class="method-signature">
- <span class="method-name">identify_packages</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Identify present packages and populate packagedata hash.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000324-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000324-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="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::PluginPackager::StandardDefinition</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::PluginPackager::StandardDefinition</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/pluginpackager/standard_definition_rb.html">
- lib/mcollective/pluginpackager/standard_definition.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000322">common</a>
- <a href="#M000320">identify_packages</a>
- <a href="#M000319">new</a>
- <a href="#M000321">plugin</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">dependencies</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">mcname</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">mcversion</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">metadata</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">packagedata</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">path</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">plugintype</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">postinstall</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">preinstall</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">revision</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">target_path</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">vendor</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000319" class="method-detail">
- <a name="M000319"></a>
-
- <div class="method-heading">
- <a href="#M000319" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(configuration, mcdependency, plugintype)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000319-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000319-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/standard_definition.rb, line 7</span>
- 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>)
- 8: <span class="ruby-ivar">@plugintype</span> = <span class="ruby-identifier">plugintype</span>
- 9: <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:target</span>]
-10: <span class="ruby-ivar">@packagedata</span> = {}
-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>
-12: <span class="ruby-ivar">@preinstall</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:preinstall</span>]
-13: <span class="ruby-ivar">@postinstall</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:postinstall</span>]
-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">"Puppet Labs"</span>
-15: <span class="ruby-ivar">@dependencies</span> = <span class="ruby-identifier">configuration</span>[<span class="ruby-identifier">:dependency</span>] <span class="ruby-operator">||</span> []
-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>)
-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>)
-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">"mcollective"</span>
-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>
-20: <span class="ruby-ivar">@dependencies</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{mcname}-common"</span>, <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@mcversion</span>}
-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">"-"</span>)
-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>])
-23: <span class="ruby-identifier">identify_packages</span>
-24: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000322" class="method-detail">
- <a name="M000322"></a>
-
- <div class="method-heading">
- <a href="#M000322" class="method-signature">
- <span class="method-name">common</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Obtain list of <a href="StandardDefinition.html#M000322">common</a> files
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000322-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000322-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/standard_definition.rb, line 54</span>
-54: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">common</span>
-55: <span class="ruby-identifier">common</span> = {<span class="ruby-identifier">:files</span> =<span class="ruby-operator">></span> [],
-56: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
-57: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"Common libraries for #{@name} connector plugin"</span>}
-58:
-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">"util"</span>)
-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>
-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">"*"</span>))
-62: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">common</span>
-63: <span class="ruby-keyword kw">else</span>
-64: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
-65: <span class="ruby-keyword kw">end</span>
-66: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000320" class="method-detail">
- <a name="M000320"></a>
-
- <div class="method-heading">
- <a href="#M000320" class="method-signature">
- <span class="method-name">identify_packages</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Identify present packages and populate the packagedata hash
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000320-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000320-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/standard_definition.rb, line 27</span>
-27: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">identify_packages</span>
-28: <span class="ruby-identifier">common_package</span> = <span class="ruby-identifier">common</span>
-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>
-30: <span class="ruby-identifier">plugin_package</span> = <span class="ruby-identifier">plugin</span>
-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>
-32: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000321" class="method-detail">
- <a name="M000321"></a>
-
- <div class="method-heading">
- <a href="#M000321" class="method-signature">
- <span class="method-name">plugin</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Obtain standard <a href="StandardDefinition.html#M000321">plugin</a> files
-and dependencies
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000321-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000321-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager/standard_definition.rb, line 35</span>
-35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">plugin</span>
-36: <span class="ruby-identifier">plugindata</span> = {<span class="ruby-identifier">:files</span> =<span class="ruby-operator">></span> [],
-37: <span class="ruby-identifier">:dependencies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@dependencies</span>.<span class="ruby-identifier">clone</span>,
-38: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{@name} #{@plugintype} plugin for the Marionette Collective."</span>}
-39:
-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>)
-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>
-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">"*"</span>))
-43: <span class="ruby-keyword kw">else</span>
-44: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
-45: <span class="ruby-keyword kw">end</span>
-46:
-47: <span class="ruby-identifier">plugindata</span>[<span class="ruby-identifier">:plugindependency</span>] = {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{@mcname}-#{@metadata[:name]}-common"</span>,
-48: <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@metadata</span>[<span class="ruby-identifier">:version</span>],
-49: <span class="ruby-identifier">:revision</span> =<span class="ruby-operator">></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>]
-50: <span class="ruby-identifier">plugindata</span>
-51: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::RPC</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::RPC</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/rpc_rb.html">
- lib/mcollective/rpc.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/rpc/actionrunner_rb.html">
- lib/mcollective/rpc/actionrunner.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/rpc/reply_rb.html">
- lib/mcollective/rpc/reply.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/rpc/progress_rb.html">
- lib/mcollective/rpc/progress.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/rpc/agent_rb.html">
- lib/mcollective/rpc/agent.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/rpc/request_rb.html">
- lib/mcollective/rpc/request.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/rpc/audit_rb.html">
- lib/mcollective/rpc/audit.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/rpc/stats_rb.html">
- lib/mcollective/rpc/stats.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/rpc/result_rb.html">
- lib/mcollective/rpc/result.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/rpc/client_rb.html">
- lib/mcollective/rpc/client.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/rpc/helpers_rb.html">
- lib/mcollective/rpc/helpers.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Toolset to create a standard interface of client and agent using an <a
-href="RPC.html">RPC</a> metaphor, standard compliant agents will make it
-easier to create generic clients like web interfaces etc
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000043">const_missing</a>
- <a href="#M000039">discovered</a>
- <a href="#M000042">empty_filter?</a>
- <a href="#M000041">printrpc</a>
- <a href="#M000040">printrpcstats</a>
- <a href="#M000037">rpcclient</a>
- <a href="#M000036">rpcoptions</a>
- <a href="#M000038">stats</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Class <a href="RPC/ActionRunner.html" class="link">MCollective::RPC::ActionRunner</a><br />
-Class <a href="RPC/Agent.html" class="link">MCollective::RPC::Agent</a><br />
-Class <a href="RPC/Audit.html" class="link">MCollective::RPC::Audit</a><br />
-Class <a href="RPC/Client.html" class="link">MCollective::RPC::Client</a><br />
-Class <a href="RPC/Helpers.html" class="link">MCollective::RPC::Helpers</a><br />
-Class <a href="RPC/Progress.html" class="link">MCollective::RPC::Progress</a><br />
-Class <a href="RPC/Reply.html" class="link">MCollective::RPC::Reply</a><br />
-Class <a href="RPC/Request.html" class="link">MCollective::RPC::Request</a><br />
-Class <a href="RPC/Result.html" class="link">MCollective::RPC::Result</a><br />
-Class <a href="RPC/Stats.html" class="link">MCollective::RPC::Stats</a><br />
-
- </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000043" class="method-detail">
- <a name="M000043"></a>
-
- <div class="method-heading">
- <a href="#M000043" class="method-signature">
- <span class="method-name">const_missing</span><span class="method-args">(const_name)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000043-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000043-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 175</span>
-175: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">const_missing</span>(<span class="ruby-identifier">const_name</span>)
-176: <span class="ruby-keyword kw">super</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">const_name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:DDL</span>
-177:
-178: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-value str">"MCollective::RPC::DDL is deprecatd, please use MCollective::DDL instead"</span>)
-179: <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">DDL</span>
-180: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000039" class="method-detail">
- <a name="M000039"></a>
-
- <div class="method-heading">
- <a href="#M000039" class="method-signature">
- <span class="method-name">discovered</span><span class="method-args">(discovered)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-means for other classes to drop <a href="RPC.html#M000039">discovered</a>
-hosts into this module its a bit hacky but needed so that the mixin methods
-like <a href="RPC.html#M000040">printrpcstats</a> can easily get access to
-it without users having to pass it around in params.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000039-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000039-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 107</span>
-107: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">discovered</span>(<span class="ruby-identifier">discovered</span>)
-108: <span class="ruby-ivar">@@discovered</span> = <span class="ruby-identifier">discovered</span>
-109: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000038" class="method-detail">
- <a name="M000038"></a>
-
- <div class="method-heading">
- <a href="#M000038" class="method-signature">
- <span class="method-name">stats</span><span class="method-args">(stats)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-means for other classes to drop <a href="RPC.html#M000038">stats</a> into
-this module its a bit hacky but needed so that the mixin methods like <a
-href="RPC.html#M000040">printrpcstats</a> can easily get access to it
-without users having to pass it around in params.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000038-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000038-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 99</span>
- 99: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">stats</span>(<span class="ruby-identifier">stats</span>)
-100: <span class="ruby-ivar">@@stats</span> = <span class="ruby-identifier">stats</span>
-101: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000042" class="method-detail">
- <a name="M000042"></a>
-
- <div class="method-heading">
- <a href="#M000042" class="method-signature">
- <span class="method-name">empty_filter?</span><span class="method-args">(options)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Wrapper for <a href="Util.html#M000288">MCollective::Util.empty_filter</a>?
-to make clients less fugly to write - ticket 18
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000042-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000042-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 167</span>
-167: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">empty_filter?</span>(<span class="ruby-identifier">options</span>)
-168: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:filter</span>)
-169: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter?</span>(<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:filter</span>])
-170: <span class="ruby-keyword kw">else</span>
-171: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter?</span>(<span class="ruby-identifier">options</span>)
-172: <span class="ruby-keyword kw">end</span>
-173: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000041" class="method-detail">
- <a name="M000041"></a>
-
- <div class="method-heading">
- <a href="#M000041" class="method-signature">
- <span class="method-name">printrpc</span><span class="method-args">(result, flags = {})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Prints the result of an <a href="RPC.html">RPC</a> call.
-</p>
-<p>
-In the default quiet mode - no flattening or verbose - only results that
-produce an error will be printed
-</p>
-<p>
-To get details of each result run with the -v command line option.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000041-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000041-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 146</span>
-146: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">printrpc</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">flags</span> = {})
-147: <span class="ruby-identifier">verbose</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:verbose</span>] <span class="ruby-keyword kw">rescue</span> <span class="ruby-identifier">verbose</span> = <span class="ruby-keyword kw">false</span>
-148: <span class="ruby-identifier">verbose</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:verbose</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">verbose</span>
-149: <span class="ruby-identifier">flatten</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:flatten</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword kw">false</span>
-150: <span class="ruby-identifier">format</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:output_format</span>]
-151: <span class="ruby-identifier">forced_mode</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:force_display_mode</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword kw">false</span>
-152:
-153: <span class="ruby-identifier">result_text</span> = <span class="ruby-constant">Helpers</span>.<span class="ruby-identifier">rpcresults</span>(<span class="ruby-identifier">result</span>, {<span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">verbose</span>, <span class="ruby-identifier">:flatten</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">flatten</span>, <span class="ruby-identifier">:format</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">format</span>, <span class="ruby-identifier">:force_display_mode</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">forced_mode</span>})
-154:
-155: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">format</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:console</span>
-156: <span class="ruby-identifier">puts</span> <span class="ruby-value str">"\n%s\n"</span> <span class="ruby-operator">%</span> [ <span class="ruby-identifier">result_text</span> ]
-157: <span class="ruby-keyword kw">else</span>
-158: <span class="ruby-comment cmt"># when we get just one result to print dont pad them all with</span>
-159: <span class="ruby-comment cmt"># blank spaces etc, just print the individual result with no</span>
-160: <span class="ruby-comment cmt"># padding</span>
-161: <span class="ruby-identifier">puts</span> <span class="ruby-identifier">result_text</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">result_text</span> <span class="ruby-operator">==</span> <span class="ruby-value str">""</span>
-162: <span class="ruby-keyword kw">end</span>
-163: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000040" class="method-detail">
- <a name="M000040"></a>
-
- <div class="method-heading">
- <a href="#M000040" class="method-signature">
- <span class="method-name">printrpcstats</span><span class="method-args">(flags={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Prints <a href="RPC.html#M000038">stats</a>, requires <a
-href="RPC.html#M000038">stats</a> to be saved from elsewhere using the <a
-href="RPC.html#M000038">MCollective::RPC.stats</a> method.
-</p>
-<p>
-If you‘ve passed -v on the command line a detailed stat block will be
-printed, else just a one liner.
-</p>
-<p>
-You can pass flags into it:
-</p>
-<pre>
- printrpcstats :caption => "Foo", :summarize => true
-</pre>
-<p>
-This will use "Foo" as the caption to the <a
-href="RPC.html#M000038">stats</a> in verbose mode and print out any
-aggregate summary information if present
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000040-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000040-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 123</span>
-123: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">printrpcstats</span>(<span class="ruby-identifier">flags</span>={})
-124: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:output_format</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">:console</span>
-125:
-126: <span class="ruby-identifier">flags</span> = {<span class="ruby-identifier">:summarize</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">:caption</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"rpc stats"</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">flags</span>)
-127:
-128: <span class="ruby-identifier">verbose</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:verbose</span>] <span class="ruby-keyword kw">rescue</span> <span class="ruby-identifier">verbose</span> = <span class="ruby-keyword kw">false</span>
-129:
-130: <span class="ruby-keyword kw">begin</span>
-131: <span class="ruby-identifier">stats</span> = <span class="ruby-ivar">@@stats</span>
-132: <span class="ruby-keyword kw">rescue</span>
-133: <span class="ruby-identifier">puts</span>(<span class="ruby-value str">"no stats to display"</span>)
-134: <span class="ruby-keyword kw">return</span>
-135: <span class="ruby-keyword kw">end</span>
-136:
-137: <span class="ruby-identifier">puts</span> <span class="ruby-identifier">stats</span>.<span class="ruby-identifier">report</span>(<span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:caption</span>], <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:summarize</span>], <span class="ruby-identifier">verbose</span>)
-138: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000037" class="method-detail">
- <a name="M000037"></a>
-
- <div class="method-heading">
- <a href="#M000037" class="method-signature">
- <span class="method-name">rpcclient</span><span class="method-args">(agent, flags = {}) {|rpc| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Wrapper to create clients, supposed to be used as a mixin:
-</p>
-<p>
-include <a href="RPC.html">MCollective::RPC</a>
-</p>
-<p>
-exim = <a href="RPC.html#M000037">rpcclient</a>("exim") <a
-href="RPC.html#M000041">printrpc</a> exim.mailq
-</p>
-<p>
-or
-</p>
-<p>
-<a href="RPC.html#M000037">rpcclient</a>("exim") do |exim|
-</p>
-<pre>
- printrpc exim.mailq
-</pre>
-<p>
-end
-</p>
-<p>
-It will take a few flags:
-</p>
-<pre>
- :configfile => "etc/client.cfg"
- :options => options
- :exit_on_failure => true
-</pre>
-<p>
-Options would be a build up options hash from the <a
-href="Optionparser.html">Optionparser</a> you can use the <a
-href="RPC.html#M000036">rpcoptions</a> helper to create this
-</p>
-<p>
-:exit_on_failure is true by default, and causes the application to exit if
-there is a failure constructing the <a href="RPC.html">RPC</a> client. Set
-this flag to false to cause an Exception to be raised instead.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000037-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000037-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 60</span>
-60: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rpcclient</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">flags</span> = {})
-61: <span class="ruby-identifier">configfile</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:configfile</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">"/etc/mcollective/client.cfg"</span>
-62: <span class="ruby-identifier">options</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:options</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword kw">nil</span>
-63:
-64: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">flags</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">:exit_on_failure</span>)
-65: <span class="ruby-identifier">exit_on_failure</span> = <span class="ruby-identifier">flags</span>[<span class="ruby-identifier">:exit_on_failure</span>]
-66: <span class="ruby-keyword kw">else</span>
-67: <span class="ruby-comment cmt"># We exit on failure by default for CLI-friendliness</span>
-68: <span class="ruby-identifier">exit_on_failure</span> = <span class="ruby-keyword kw">true</span>
-69: <span class="ruby-keyword kw">end</span>
-70:
-71: <span class="ruby-keyword kw">begin</span>
-72: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>
-73: <span class="ruby-identifier">rpc</span> = <span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:configfile</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:config</span>], <span class="ruby-identifier">:options</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span>)
-74: <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">rpc</span>.<span class="ruby-identifier">options</span>
-75: <span class="ruby-keyword kw">else</span>
-76: <span class="ruby-identifier">rpc</span> = <span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:configfile</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">configfile</span>)
-77: <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">rpc</span>.<span class="ruby-identifier">options</span>
-78: <span class="ruby-keyword kw">end</span>
-79: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-80: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">exit_on_failure</span>
-81: <span class="ruby-identifier">puts</span>(<span class="ruby-node">"Could not create RPC client: #{e}"</span>)
-82: <span class="ruby-identifier">exit!</span>
-83: <span class="ruby-keyword kw">else</span>
-84: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
-85: <span class="ruby-keyword kw">end</span>
-86: <span class="ruby-keyword kw">end</span>
-87:
-88: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-89: <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">rpc</span>)
-90: <span class="ruby-keyword kw">else</span>
-91: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">rpc</span>
-92: <span class="ruby-keyword kw">end</span>
-93: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000036" class="method-detail">
- <a name="M000036"></a>
-
- <div class="method-heading">
- <a href="#M000036" class="method-signature">
- <span class="method-name">rpcoptions</span><span class="method-args">() {|parser, options| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates a standard options hash, pass in a block to add extra headings etc
-see <a href="Optionparser.html">Optionparser</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000036-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000036-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc.rb, line 21</span>
-21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rpcoptions</span>
-22: <span class="ruby-identifier">oparser</span> = <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">Optionparser</span>.<span class="ruby-identifier">new</span>({<span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">:progress_bar</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>}, <span class="ruby-value str">"filter"</span>)
-23:
-24: <span class="ruby-identifier">options</span> = <span class="ruby-identifier">oparser</span>.<span class="ruby-identifier">parse</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">parser</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
-25: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-26: <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">parser</span>, <span class="ruby-identifier">options</span>)
-27: <span class="ruby-keyword kw">end</span>
-28:
-29: <span class="ruby-constant">Helpers</span>.<span class="ruby-identifier">add_simplerpc_options</span>(<span class="ruby-identifier">parser</span>, <span class="ruby-identifier">options</span>)
-30: <span class="ruby-keyword kw">end</span>
-31:
-32: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">options</span>
-33: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::RPC::ActionRunner</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::ActionRunner</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/actionrunner_rb.html">
- lib/mcollective/rpc/actionrunner.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A helper used by RPC::Agent#implemented_by to delegate an action to an
-external script. At present only JSON based serialization is supported in
-future ones based on key=val pairs etc will be added
-</p>
-<p>
-It serializes the request object into an input file and creates an empty
-output file. It then calls the external command reading the output file at
-the end.
-</p>
-<p>
-any STDERR gets logged at error level and any STDOUT gets logged at info
-level.
-</p>
-<p>
-It will interpret the exit code from the application the same way <a
-href="Reply.html#M000074">RPC::Reply#fail</a>! and fail handles their codes
-creating a consistent interface, the message part of the fail message will
-come from STDERR
-</p>
-<p>
-Generally externals should just exit with code 1 on failure and print to
-STDERR, this is exactly what Perl die() does and translates perfectly to
-our model
-</p>
-<p>
-It uses the <a href="../Shell.html">MCollective::Shell</a> wrapper to call
-the external application
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000066">canrun?</a>
- <a href="#M000063">load_json_results</a>
- <a href="#M000062">load_results</a>
- <a href="#M000059">new</a>
- <a href="#M000069">path_to_command</a>
- <a href="#M000060">run</a>
- <a href="#M000065">save_json_request</a>
- <a href="#M000064">saverequest</a>
- <a href="#M000061">shell</a>
- <a href="#M000068">tempfile</a>
- <a href="#M000067">to_s</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">action</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">agent</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">command</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">format</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">request</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">stderr</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">stdout</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000059" class="method-detail">
- <a name="M000059"></a>
-
- <div class="method-heading">
- <a href="#M000059" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(command, request, format=:json)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000059-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000059-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 26</span>
-26: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">request</span>, <span class="ruby-identifier">format</span>=<span class="ruby-identifier">:json</span>)
-27: <span class="ruby-ivar">@agent</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">agent</span>
-28: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">action</span>
-29: <span class="ruby-ivar">@format</span> = <span class="ruby-identifier">format</span>
-30: <span class="ruby-ivar">@request</span> = <span class="ruby-identifier">request</span>
-31: <span class="ruby-ivar">@command</span> = <span class="ruby-identifier">path_to_command</span>(<span class="ruby-identifier">command</span>)
-32: <span class="ruby-ivar">@stdout</span> = <span class="ruby-value str">""</span>
-33: <span class="ruby-ivar">@stderr</span> = <span class="ruby-value str">""</span>
-34: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000066" class="method-detail">
- <a name="M000066"></a>
-
- <div class="method-heading">
- <a href="#M000066" class="method-signature">
- <span class="method-name">canrun?</span><span class="method-args">(command)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000066-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000066-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 117</span>
-117: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">canrun?</span>(<span class="ruby-identifier">command</span>)
-118: <span class="ruby-constant">File</span>.<span class="ruby-identifier">executable?</span>(<span class="ruby-identifier">command</span>)
-119: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000063" class="method-detail">
- <a name="M000063"></a>
-
- <div class="method-heading">
- <a href="#M000063" class="method-signature">
- <span class="method-name">load_json_results</span><span class="method-args">(file)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000063-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000063-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 91</span>
-91: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_json_results</span>(<span class="ruby-identifier">file</span>)
-92: <span class="ruby-keyword kw">return</span> {} <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">readable?</span>(<span class="ruby-identifier">file</span>)
-93:
-94: <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">file</span>)) <span class="ruby-operator">||</span> {}
-95: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">JSON</span><span class="ruby-operator">::</span><span class="ruby-constant">ParserError</span>
-96: {}
-97: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000062" class="method-detail">
- <a name="M000062"></a>
-
- <div class="method-heading">
- <a href="#M000062" class="method-signature">
- <span class="method-name">load_results</span><span class="method-args">(file)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000062-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000062-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 73</span>
-73: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_results</span>(<span class="ruby-identifier">file</span>)
-74: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Attempting to load results in #{format} format from #{file}"</span>)
-75:
-76: <span class="ruby-identifier">data</span> = {}
-77:
-78: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-node">"load_#{format}_results"</span>)
-79: <span class="ruby-identifier">tempdata</span> = <span class="ruby-identifier">send</span>(<span class="ruby-node">"load_#{format}_results"</span>, <span class="ruby-identifier">file</span>)
-80:
-81: <span class="ruby-identifier">tempdata</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
-82: <span class="ruby-identifier">data</span>[<span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">v</span>
-83: <span class="ruby-keyword kw">end</span>
-84: <span class="ruby-keyword kw">end</span>
-85:
-86: <span class="ruby-identifier">data</span>
-87: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-88: {}
-89: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000069" class="method-detail">
- <a name="M000069"></a>
-
- <div class="method-heading">
- <a href="#M000069" class="method-signature">
- <span class="method-name">path_to_command</span><span class="method-args">(command)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000069-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000069-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 129</span>
-129: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">path_to_command</span>(<span class="ruby-identifier">command</span>)
-130: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">command</span>[<span class="ruby-value">0</span>,<span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>
-131: <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">libdir</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">libdir</span><span class="ruby-operator">|</span>
-132: <span class="ruby-identifier">command_file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">libdir</span>, <span class="ruby-value str">"agent"</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">command</span>)
-133:
-134: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">command_file</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">command_file</span>)
-135: <span class="ruby-keyword kw">end</span>
-136: <span class="ruby-keyword kw">end</span>
-137:
-138: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">command</span>
-139: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000060" class="method-detail">
- <a name="M000060"></a>
-
- <div class="method-heading">
- <a href="#M000060" class="method-signature">
- <span class="method-name">run</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000060-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000060-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 36</span>
-36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>
-37: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">canrun?</span>(<span class="ruby-identifier">command</span>)
-38: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Cannot run #{to_s}"</span>)
-39: <span class="ruby-identifier">raise</span> <span class="ruby-constant">RPCAborted</span>, <span class="ruby-node">"Cannot execute #{to_s}"</span>
-40: <span class="ruby-keyword kw">end</span>
-41:
-42: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Running #{to_s}"</span>)
-43:
-44: <span class="ruby-identifier">request_file</span> = <span class="ruby-identifier">saverequest</span>(<span class="ruby-identifier">request</span>)
-45: <span class="ruby-identifier">reply_file</span> = <span class="ruby-identifier">tempfile</span>(<span class="ruby-value str">"reply"</span>)
-46: <span class="ruby-identifier">reply_file</span>.<span class="ruby-identifier">close</span>
-47:
-48: <span class="ruby-identifier">runner</span> = <span class="ruby-identifier">shell</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">request_file</span>.<span class="ruby-identifier">path</span>, <span class="ruby-identifier">reply_file</span>.<span class="ruby-identifier">path</span>)
-49:
-50: <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">runcommand</span>
-51:
-52: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"#{command} exited with #{runner.status.exitstatus}"</span>)
-53:
-54: <span class="ruby-identifier">stderr</span>.<span class="ruby-identifier">each_line</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"#{to_s}: #{l.chomp}"</span>)} <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">stderr</span>.<span class="ruby-identifier">empty?</span>
-55: <span class="ruby-identifier">stdout</span>.<span class="ruby-identifier">each_line</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">"#{to_s}: #{l.chomp}"</span>)} <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">stdout</span>.<span class="ruby-identifier">empty?</span>
-56:
-57: {<span class="ruby-identifier">:exitstatus</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">status</span>.<span class="ruby-identifier">exitstatus</span>,
-58: <span class="ruby-identifier">:stdout</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">stdout</span>,
-59: <span class="ruby-identifier">:stderr</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">stderr</span>,
-60: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">load_results</span>(<span class="ruby-identifier">reply_file</span>.<span class="ruby-identifier">path</span>)}
-61: <span class="ruby-keyword kw">ensure</span>
-62: <span class="ruby-identifier">request_file</span>.<span class="ruby-identifier">close!</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">request_file</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"close!"</span>)
-63: <span class="ruby-identifier">reply_file</span>.<span class="ruby-identifier">close!</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">reply_file</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"close"</span>)
-64: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000065" class="method-detail">
- <a name="M000065"></a>
-
- <div class="method-heading">
- <a href="#M000065" class="method-signature">
- <span class="method-name">save_json_request</span><span class="method-args">(req)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000065-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000065-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 113</span>
-113: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">save_json_request</span>(<span class="ruby-identifier">req</span>)
-114: <span class="ruby-identifier">req</span>.<span class="ruby-identifier">to_json</span>
-115: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000064" class="method-detail">
- <a name="M000064"></a>
-
- <div class="method-heading">
- <a href="#M000064" class="method-signature">
- <span class="method-name">saverequest</span><span class="method-args">(req)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000064-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000064-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 99</span>
- 99: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">saverequest</span>(<span class="ruby-identifier">req</span>)
-100: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Attempting to save request in #{format} format"</span>)
-101:
-102: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-node">"save_#{format}_request"</span>)
-103: <span class="ruby-identifier">data</span> = <span class="ruby-identifier">send</span>(<span class="ruby-node">"save_#{format}_request"</span>, <span class="ruby-identifier">req</span>)
-104:
-105: <span class="ruby-identifier">request_file</span> = <span class="ruby-identifier">tempfile</span>(<span class="ruby-value str">"request"</span>)
-106: <span class="ruby-identifier">request_file</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">data</span>
-107: <span class="ruby-identifier">request_file</span>.<span class="ruby-identifier">close</span>
-108: <span class="ruby-keyword kw">end</span>
-109:
-110: <span class="ruby-identifier">request_file</span>
-111: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000061" class="method-detail">
- <a name="M000061"></a>
-
- <div class="method-heading">
- <a href="#M000061" class="method-signature">
- <span class="method-name">shell</span><span class="method-args">(command, infile, outfile)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000061-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000061-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 66</span>
-66: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">shell</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">infile</span>, <span class="ruby-identifier">outfile</span>)
-67: <span class="ruby-identifier">env</span> = {<span class="ruby-value str">"MCOLLECTIVE_REQUEST_FILE"</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">infile</span>,
-68: <span class="ruby-value str">"MCOLLECTIVE_REPLY_FILE"</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">outfile</span>}
-69:
-70: <span class="ruby-constant">Shell</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"#{command} #{infile} #{outfile}"</span>, <span class="ruby-identifier">:cwd</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">tmpdir</span>, <span class="ruby-identifier">:stdout</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">stdout</span>, <span class="ruby-identifier">:stderr</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">stderr</span>, <span class="ruby-identifier">:environment</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">env</span>)
-71: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000068" class="method-detail">
- <a name="M000068"></a>
-
- <div class="method-heading">
- <a href="#M000068" class="method-signature">
- <span class="method-name">tempfile</span><span class="method-args">(prefix)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000068-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000068-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 125</span>
-125: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tempfile</span>(<span class="ruby-identifier">prefix</span>)
-126: <span class="ruby-constant">Tempfile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"mcollective_#{prefix}"</span>, <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">tmpdir</span>)
-127: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000067" class="method-detail">
- <a name="M000067"></a>
-
- <div class="method-heading">
- <a href="#M000067" class="method-signature">
- <span class="method-name">to_s</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000067-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000067-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/actionrunner.rb, line 121</span>
-121: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
-122: <span class="ruby-value str">"%s#%s command: %s"</span> <span class="ruby-operator">%</span> [ <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">command</span> ]
-123: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::RPC::Agent</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::Agent</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/agent_rb.html">
- lib/mcollective/rpc/agent.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A wrapper around the traditional agent, it takes care of a lot of the
-tedious setup you would do for each agent allowing you to just create
-methods following a naming standard leaving the heavy lifting up to this
-clas.
-</p>
-<p>
-See <a
-href="http://marionette-collective.org/simplerpc/agents.html">marionette-collective.org/simplerpc/agents.html</a>
-</p>
-<p>
-It only really makes sense to use this with a Simple <a
-href="../RPC.html">RPC</a> client on the other end, basic usage would be:
-</p>
-<pre>
- module MCollective
- module Agent
- class Helloworld<RPC::Agent
- action "hello" do
- reply[:msg] = "Hello #{request[:name]}"
- end
-
- action "foo" do
- implemented_by "/some/script.sh"
- end
- end
- end
- end
-</pre>
-<p>
-If you wish to implement the logic for an action using an external script
-use the implemented_by method that will cause your script to be run with 2
-arguments.
-</p>
-<p>
-The first argument is a file containing JSON with the request and the 2nd
-argument is where the script should save its output as a JSON hash.
-</p>
-<p>
-We also currently have the validation code in here, this will be moved to
-plugins soon.
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000084">actions</a>
- <a href="#M000083">activate?</a>
- <a href="#M000082">handlemsg</a>
- <a href="#M000081">load_ddl</a>
- <a href="#M000080">new</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
- <div id="includes">
- <h3 class="section-bar">Included Modules</h3>
-
- <div id="includes-list">
- <span class="include-name"><a href="../Translatable.html">Translatable</a></span>
- </div>
- </div>
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">agent_name</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">config</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ddl</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">logger</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">meta</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">reply</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">request</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">timeout</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000084" class="method-detail">
- <a name="M000084"></a>
-
- <div class="method-heading">
- <a href="#M000084" class="method-signature">
- <span class="method-name">actions</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns an array of <a href="Agent.html#M000084">actions</a> this agent
-support
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000084-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000084-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 157</span>
-157: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">actions</span>
-158: <span class="ruby-identifier">public_instance_methods</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-regexp re">/_action$/</span>).<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">method</span><span class="ruby-operator">|</span>
-159: <span class="ruby-identifier">$1</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">method</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/(.+)_action$/</span>
-160: <span class="ruby-keyword kw">end</span>
-161: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000083" class="method-detail">
- <a name="M000083"></a>
-
- <div class="method-heading">
- <a href="#M000083" class="method-signature">
- <span class="method-name">activate?</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-By default <a href="../RPC.html">RPC</a> <a
-href="../Agents.html">Agents</a> support a toggle in the configuration that
-can enable and disable them based on the agent name
-</p>
-<p>
-Example an agent called Foo can have:
-</p>
-<p>
-plugin.foo.activate_agent = false
-</p>
-<p>
-and this will prevent the agent from loading on this particular machine.
-</p>
-<p>
-<a href="../Agents.html">Agents</a> can use the activate_when helper to
-override this for example:
-</p>
-<p>
-activate_when do
-</p>
-<pre>
- File.exist?("/usr/bin/puppet")
-</pre>
-<p>
-end
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000083-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000083-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 142</span>
-142: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">activate?</span>
-143: <span class="ruby-identifier">agent_name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"::"</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
-144:
-145: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC37</span>, <span class="ruby-value str">"Starting default activation checks for the '%{agent}' agent"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">agent_name</span>)
-146:
-147: <span class="ruby-identifier">should_activate</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">pluginconf</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-node">"#{agent_name}.activate_agent"</span>, <span class="ruby-keyword kw">true</span>))
-148:
-149: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">should_activate</span>
-150: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC38</span>, <span class="ruby-value str">"Found plugin configuration '%{agent}.activate_agent' with value '%{should_activate}'"</span>, <span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">agent_name</span>, <span class="ruby-identifier">:should_activate</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">should_activate</span>)
-151: <span class="ruby-keyword kw">end</span>
-152:
-153: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">should_activate</span>
-154: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000080" class="method-detail">
- <a name="M000080"></a>
-
- <div class="method-heading">
- <a href="#M000080" class="method-signature">
- <span class="method-name">new</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000080-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000080-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 40</span>
-40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
-41: <span class="ruby-ivar">@agent_name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"::"</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
-42:
-43: <span class="ruby-identifier">load_ddl</span>
-44:
-45: <span class="ruby-ivar">@logger</span> = <span class="ruby-constant">Log</span>.<span class="ruby-identifier">instance</span>
-46: <span class="ruby-ivar">@config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
-47:
-48: <span class="ruby-comment cmt"># if we have a global authorization provider enable it</span>
-49: <span class="ruby-comment cmt"># plugins can still override it per plugin</span>
-50: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">authorized_by</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">rpcauthprovider</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">rpcauthorization</span>
-51:
-52: <span class="ruby-identifier">startup_hook</span>
-53: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000082" class="method-detail">
- <a name="M000082"></a>
-
- <div class="method-heading">
- <a href="#M000082" class="method-signature">
- <span class="method-name">handlemsg</span><span class="method-args">(msg, connection)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000082-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000082-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 64</span>
- 64: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">handlemsg</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">connection</span>)
- 65: <span class="ruby-ivar">@request</span> = <span class="ruby-constant">RPC</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-ivar">@ddl</span>)
- 66: <span class="ruby-ivar">@reply</span> = <span class="ruby-constant">RPC</span><span class="ruby-operator">::</span><span class="ruby-constant">Reply</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@request</span>.<span class="ruby-identifier">action</span>, <span class="ruby-ivar">@ddl</span>)
- 67:
- 68: <span class="ruby-keyword kw">begin</span>
- 69: <span class="ruby-comment cmt"># Incoming requests need to be validated against the DDL thus reusing</span>
- 70: <span class="ruby-comment cmt"># all the work users put into creating DDLs and creating a consistent</span>
- 71: <span class="ruby-comment cmt"># quality of input validation everywhere with the a simple once off</span>
- 72: <span class="ruby-comment cmt"># investment of writing a DDL</span>
- 73: <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">validate!</span>
- 74:
- 75: <span class="ruby-comment cmt"># Calls the authorization plugin if any is defined</span>
- 76: <span class="ruby-comment cmt"># if this raises an exception we wil just skip processing this</span>
- 77: <span class="ruby-comment cmt"># message</span>
- 78: <span class="ruby-identifier">authorization_hook</span>(<span class="ruby-ivar">@request</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"authorization_hook"</span>)
- 79:
- 80: <span class="ruby-comment cmt"># Audits the request, currently continues processing the message</span>
- 81: <span class="ruby-comment cmt"># we should make this a configurable so that an audit failure means</span>
- 82: <span class="ruby-comment cmt"># a message wont be processed by this node depending on config</span>
- 83: <span class="ruby-identifier">audit_request</span>(<span class="ruby-ivar">@request</span>, <span class="ruby-identifier">connection</span>)
- 84:
- 85: <span class="ruby-identifier">before_processing_hook</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">connection</span>)
- 86:
- 87: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-node">"#{@request.action}_action"</span>)
- 88: <span class="ruby-identifier">send</span>(<span class="ruby-node">"#{@request.action}_action"</span>)
- 89: <span class="ruby-keyword kw">else</span>
- 90: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC36</span>, <span class="ruby-value str">"Unknown action '%{action}' for agent '%{agent}'"</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">action</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">agent</span>)
- 91: <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownRPCAction</span>, <span class="ruby-node">"Unknown action '#{@request.action}' for agent '#{@request.agent}'"</span>
- 92: <span class="ruby-keyword kw">end</span>
- 93: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">RPCAborted</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
- 94: <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">1</span>
- 95:
- 96: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">UnknownRPCAction</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
- 97: <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">2</span>
- 98:
- 99: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">MissingRPCData</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-100: <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">3</span>
-101:
-102: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">InvalidRPCData</span>, <span class="ruby-constant">DDLValidationError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-103: <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">4</span>
-104:
-105: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">UnknownRPCError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-106: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-value str">"%s#%s failed: %s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@agent_name</span>, <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">action</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>])
-107: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n\t"</span>))
-108: <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">5</span>
-109:
-110: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-111: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-value str">"%s#%s failed: %s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@agent_name</span>, <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">action</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>])
-112: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n\t"</span>))
-113: <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">fail</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">5</span>
-114:
-115: <span class="ruby-keyword kw">end</span>
-116:
-117: <span class="ruby-identifier">after_processing_hook</span>
-118:
-119: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">should_respond?</span>
-120: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@reply</span>.<span class="ruby-identifier">to_hash</span>
-121: <span class="ruby-keyword kw">else</span>
-122: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC35</span>, <span class="ruby-value str">"Client did not request a response, surpressing reply"</span>, <span class="ruby-identifier">:debug</span>)
-123: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
-124: <span class="ruby-keyword kw">end</span>
-125: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000081" class="method-detail">
- <a name="M000081"></a>
-
- <div class="method-heading">
- <a href="#M000081" class="method-signature">
- <span class="method-name">load_ddl</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000081-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000081-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/agent.rb, line 55</span>
-55: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_ddl</span>
-56: <span class="ruby-ivar">@ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@agent_name</span>, <span class="ruby-identifier">:agent</span>)
-57: <span class="ruby-ivar">@meta</span> = <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">meta</span>
-58: <span class="ruby-ivar">@timeout</span> = <span class="ruby-ivar">@meta</span>[<span class="ruby-identifier">:timeout</span>] <span class="ruby-operator">||</span> <span class="ruby-value">10</span>
-59:
-60: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-61: <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">validation_fail!</span>(<span class="ruby-identifier">:PLMC24</span>, <span class="ruby-value str">"Failed to load DDL for the '%{agent}' agent, DDLs are required: %{error_class}: %{error}"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@agent_name</span>, <span class="ruby-identifier">:error_class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>)
-62: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::RPC::Audit</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::Audit</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/audit_rb.html">
- lib/mcollective/rpc/audit.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Auditing of requests is done only for SimpleRPC requests, you provide a
-plugin in the MCollective::Audit::* namespace which the SimpleRPC framework
-calls for each message
-</p>
-<p>
-We provide a simple one that logs to a logfile in the class
-MCollective::Audit::Logfile you can create your own:
-</p>
-<p>
-Create a class in plugins/mcollective/audit/<yourplugin>.rb
-</p>
-<p>
-You must inherit from <a href="Audit.html">MCollective::RPC::Audit</a>
-which will take care of registering you with the plugin system.
-</p>
-<p>
-Your plugin must provide <a
-href="Audit.html#M000071">audit_request</a>(request, connection) the
-request parameter will be an instance of <a
-href="Request.html">MCollective::RPC::Request</a>
-</p>
-<p>
-To enable auditing you should set:
-</p>
-<p>
-rpcaudit = 1 rpcauditprovider = Logfile
-</p>
-<p>
-in the config file this will enable logging using the
-MCollective::Audit::Logile class
-</p>
-<p>
-The <a href="Audit.html">Audit</a> class acts as a base for audit plugins
-and takes care of registering them with the plugin manager
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000071">audit_request</a>
- <a href="#M000070">inherited</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000070" class="method-detail">
- <a name="M000070"></a>
-
- <div class="method-heading">
- <a href="#M000070" class="method-signature">
- <span class="method-name">inherited</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000070-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000070-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/audit.rb, line 29</span>
-29: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
-30: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"rpcaudit_plugin"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>}
-31: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000071" class="method-detail">
- <a name="M000071"></a>
-
- <div class="method-heading">
- <a href="#M000071" class="method-signature">
- <span class="method-name">audit_request</span><span class="method-args">(request, connection)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000071-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000071-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/audit.rb, line 33</span>
-33: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">audit_request</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">connection</span>)
-34: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"audit_request is not implimented in #{this.class}"</span>)
-35: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::RPC::Progress</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::Progress</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/progress_rb.html">
- lib/mcollective/rpc/progress.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Class that shows a progress bar, currently only supports a twirling
-progress bar.
-</p>
-<p>
-You can specify a size for the progress bar if you want if you dont it will
-use the helper functions to figure out terminal dimensions and draw an
-appropriately sized bar
-</p>
-<p>
-p = <a href="Progress.html#M000051">Progress.new</a> 100.times {|i| print
-p.twirl(i+1, 100) + "\r"};puts
-</p>
-<pre>
- * [ ==================================================> ] 100 / 100
-</pre>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000051">new</a>
- <a href="#M000052">twirl</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000051" class="method-detail">
- <a name="M000051"></a>
-
- <div class="method-heading">
- <a href="#M000051" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(size=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000051-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000051-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/progress.rb, line 15</span>
-15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">size</span>=<span class="ruby-keyword kw">nil</span>)
-16: <span class="ruby-ivar">@twirl</span> = [<span class="ruby-value str">'|'</span>, <span class="ruby-value str">'/'</span>, <span class="ruby-value str">'-'</span>, <span class="ruby-value str">"\\"</span>, <span class="ruby-value str">'|'</span>, <span class="ruby-value str">'/'</span>, <span class="ruby-value str">'-'</span>, <span class="ruby-value str">"\\"</span>]
-17: <span class="ruby-ivar">@twirldex</span> = <span class="ruby-value">0</span>
-18:
-19: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">size</span>
-20: <span class="ruby-ivar">@size</span> = <span class="ruby-identifier">size</span>
-21: <span class="ruby-keyword kw">else</span>
-22: <span class="ruby-identifier">cols</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">terminal_dimensions</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">-</span> <span class="ruby-value">22</span>
-23:
-24: <span class="ruby-comment cmt"># Defaults back to old behavior if it</span>
-25: <span class="ruby-comment cmt"># couldn't figure out the size or if</span>
-26: <span class="ruby-comment cmt"># its more than 60 wide</span>
-27: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">cols</span> <span class="ruby-operator"><=</span> <span class="ruby-value">0</span>
-28: <span class="ruby-ivar">@size</span> = <span class="ruby-value">0</span>
-29: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">cols</span> <span class="ruby-operator">></span> <span class="ruby-value">60</span>
-30: <span class="ruby-ivar">@size</span> = <span class="ruby-value">60</span>
-31: <span class="ruby-keyword kw">else</span>
-32: <span class="ruby-ivar">@size</span> = <span class="ruby-identifier">cols</span>
-33: <span class="ruby-keyword kw">end</span>
-34: <span class="ruby-keyword kw">end</span>
-35: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000052" class="method-detail">
- <a name="M000052"></a>
-
- <div class="method-heading">
- <a href="#M000052" class="method-signature">
- <span class="method-name">twirl</span><span class="method-args">(current, total)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000052-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000052-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/progress.rb, line 37</span>
-37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">twirl</span>(<span class="ruby-identifier">current</span>, <span class="ruby-identifier">total</span>)
-38: <span class="ruby-comment cmt"># if the size is negative there is just not enough</span>
-39: <span class="ruby-comment cmt"># space on the terminal, return a simpler version</span>
-40: <span class="ruby-keyword kw">return</span> <span class="ruby-node">"\r#{current} / #{total}"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
-41:
-42: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">current</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">total</span>
-43: <span class="ruby-identifier">txt</span> = <span class="ruby-value str">"\r %s [ "</span> <span class="ruby-operator">%</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:green</span>, <span class="ruby-value str">"*"</span>)
-44: <span class="ruby-keyword kw">else</span>
-45: <span class="ruby-identifier">txt</span> = <span class="ruby-value str">"\r %s [ "</span> <span class="ruby-operator">%</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-ivar">@twirl</span>[<span class="ruby-ivar">@twirldex</span>])
-46: <span class="ruby-keyword kw">end</span>
-47:
-48: <span class="ruby-identifier">dashes</span> = ((<span class="ruby-identifier">current</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">total</span>) <span class="ruby-operator">*</span> <span class="ruby-ivar">@size</span>).<span class="ruby-identifier">round</span>
-49:
-50: <span class="ruby-identifier">dashes</span>.<span class="ruby-identifier">times</span> { <span class="ruby-identifier">txt</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"="</span> }
-51: <span class="ruby-identifier">txt</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">">"</span>
-52:
-53: (<span class="ruby-ivar">@size</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">dashes</span>).<span class="ruby-identifier">times</span> { <span class="ruby-identifier">txt</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" "</span> }
-54:
-55: <span class="ruby-identifier">txt</span> <span class="ruby-operator"><<</span> <span class="ruby-node">" ] #{current} / #{total}"</span>
-56:
-57: <span class="ruby-ivar">@twirldex</span> <span class="ruby-operator">==</span> <span class="ruby-value">7</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@twirldex</span> = <span class="ruby-value">0</span> <span class="ruby-operator">:</span> <span class="ruby-ivar">@twirldex</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
-58:
-59: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">txt</span>
-60: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::RPC::Reply</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::Reply</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/reply_rb.html">
- lib/mcollective/rpc/reply.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Simple class to manage compliant replies to <a
-href="../RPC.html">MCollective::RPC</a>
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000077">[]</a>
- <a href="#M000076">[]=</a>
- <a href="#M000074">fail</a>
- <a href="#M000075">fail!</a>
- <a href="#M000078">fetch</a>
- <a href="#M000073">initialize_data</a>
- <a href="#M000072">new</a>
- <a href="#M000079">to_hash</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">data</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">statuscode</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">statusmsg</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000072" class="method-detail">
- <a name="M000072"></a>
-
- <div class="method-heading">
- <a href="#M000072" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(action, ddl)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000072-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000072-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 7</span>
- 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">ddl</span>)
- 8: <span class="ruby-ivar">@data</span> = {}
- 9: <span class="ruby-ivar">@statuscode</span> = <span class="ruby-value">0</span>
-10: <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-value str">"OK"</span>
-11: <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">ddl</span>
-12: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
-13:
-14: <span class="ruby-keyword kw">begin</span>
-15: <span class="ruby-identifier">initialize_data</span>
-16: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-17: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-value str">"Could not pre-populate reply data from the DDL: %s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span> ])
-18: <span class="ruby-keyword kw">end</span>
-19: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000077" class="method-detail">
- <a name="M000077"></a>
-
- <div class="method-heading">
- <a href="#M000077" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(key)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Read from the data hash
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000077-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000077-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 70</span>
-70: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
-71: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>]
-72: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000076" class="method-detail">
- <a name="M000076"></a>
-
- <div class="method-heading">
- <a href="#M000076" class="method-signature">
- <span class="method-name">[]=</span><span class="method-args">(key, val)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Write to the data hash
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000076-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000076-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 65</span>
-65: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span>)
-66: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">val</span>
-67: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000074" class="method-detail">
- <a name="M000074"></a>
-
- <div class="method-heading">
- <a href="#M000074" class="method-signature">
- <span class="method-name">fail</span><span class="method-args">(msg, code=1)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Helper to fill in statusmsg and code on failure
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000074-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000074-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 36</span>
-36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fail</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">code</span>=<span class="ruby-value">1</span>)
-37: <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-identifier">msg</span>
-38: <span class="ruby-ivar">@statuscode</span> = <span class="ruby-identifier">code</span>
-39: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000075" class="method-detail">
- <a name="M000075"></a>
-
- <div class="method-heading">
- <a href="#M000075" class="method-signature">
- <span class="method-name">fail!</span><span class="method-args">(msg, code=1)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Helper that fills in statusmsg and code but also raises an appropriate
-error
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000075-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000075-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 42</span>
-42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fail!</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">code</span>=<span class="ruby-value">1</span>)
-43: <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-identifier">msg</span>
-44: <span class="ruby-ivar">@statuscode</span> = <span class="ruby-identifier">code</span>
-45:
-46: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">code</span>
-47: <span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span>
-48: <span class="ruby-identifier">raise</span> <span class="ruby-constant">RPCAborted</span>, <span class="ruby-identifier">msg</span>
-49:
-50: <span class="ruby-keyword kw">when</span> <span class="ruby-value">2</span>
-51: <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownRPCAction</span>, <span class="ruby-identifier">msg</span>
-52:
-53: <span class="ruby-keyword kw">when</span> <span class="ruby-value">3</span>
-54: <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingRPCData</span>, <span class="ruby-identifier">msg</span>
-55:
-56: <span class="ruby-keyword kw">when</span> <span class="ruby-value">4</span>
-57: <span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidRPCData</span>, <span class="ruby-identifier">msg</span>
-58:
-59: <span class="ruby-keyword kw">else</span>
-60: <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownRPCError</span>, <span class="ruby-identifier">msg</span>
-61: <span class="ruby-keyword kw">end</span>
-62: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000078" class="method-detail">
- <a name="M000078"></a>
-
- <div class="method-heading">
- <a href="#M000078" class="method-signature">
- <span class="method-name">fetch</span><span class="method-args">(key, default)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000078-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000078-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 74</span>
-74: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
-75: <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
-76: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000073" class="method-detail">
- <a name="M000073"></a>
-
- <div class="method-heading">
- <a href="#M000073" class="method-signature">
- <span class="method-name">initialize_data</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000073-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000073-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 21</span>
-21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize_data</span>
-22: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">actions</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@action</span>)
-23: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No action '%s' defined for agent '%s' in the DDL"</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@action</span>, <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">pluginname</span>]
-24: <span class="ruby-keyword kw">end</span>
-25:
-26: <span class="ruby-identifier">interface</span> = <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">action_interface</span>(<span class="ruby-ivar">@action</span>)
-27:
-28: <span class="ruby-identifier">interface</span>[<span class="ruby-identifier">:output</span>].<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span><span class="ruby-operator">|</span>
-29: <span class="ruby-comment cmt"># must deep clone this data to avoid accidental updates of the DDL in cases where the</span>
-30: <span class="ruby-comment cmt"># default is for example a string and someone does << on it</span>
-31: <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">output</span>] = <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">interface</span>[<span class="ruby-identifier">:output</span>][<span class="ruby-identifier">output</span>].<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:default</span>, <span class="ruby-keyword kw">nil</span>)))
-32: <span class="ruby-keyword kw">end</span>
-33: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000079" class="method-detail">
- <a name="M000079"></a>
-
- <div class="method-heading">
- <a href="#M000079" class="method-signature">
- <span class="method-name">to_hash</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns a compliant Hash of the reply that should be sent over the
-middleware
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000079-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000079-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 80</span>
-80: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
-81: <span class="ruby-keyword kw">return</span> {<span class="ruby-identifier">:statuscode</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@statuscode</span>,
-82: <span class="ruby-identifier">:statusmsg</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@statusmsg</span>,
-83: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@data</span>}
-84: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::RPC::Request</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::Request</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/request_rb.html">
- lib/mcollective/rpc/request.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Simple class to manage compliant requests for <a
-href="../RPC.html">MCollective::RPC</a> agents
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000138">[]</a>
- <a href="#M000139">fetch</a>
- <a href="#M000136">include?</a>
- <a href="#M000135">new</a>
- <a href="#M000137">should_respond?</a>
- <a href="#M000140">to_hash</a>
- <a href="#M000142">to_json</a>
- <a href="#M000141">validate!</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">action</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">agent</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">caller</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">data</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">ddl</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">sender</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">time</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">uniqid</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000135" class="method-detail">
- <a name="M000135"></a>
-
- <div class="method-heading">
- <a href="#M000135" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(msg, ddl)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000135-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000135-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 7</span>
- 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">ddl</span>)
- 8: <span class="ruby-ivar">@time</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:msgtime</span>]
- 9: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:action</span>]
-10: <span class="ruby-ivar">@data</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:data</span>]
-11: <span class="ruby-ivar">@sender</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:senderid</span>]
-12: <span class="ruby-ivar">@agent</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:body</span>][<span class="ruby-identifier">:agent</span>]
-13: <span class="ruby-ivar">@uniqid</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:requestid</span>]
-14: <span class="ruby-ivar">@caller</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-identifier">:callerid</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">"unknown"</span>
-15: <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">ddl</span>
-16: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000138" class="method-detail">
- <a name="M000138"></a>
-
- <div class="method-heading">
- <a href="#M000138" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(key)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-If data is a hash, gives easy access to its members, else returns nil
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000138-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000138-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 34</span>
-34: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
-35: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
-36: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>]
-37: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000139" class="method-detail">
- <a name="M000139"></a>
-
- <div class="method-heading">
- <a href="#M000139" class="method-signature">
- <span class="method-name">fetch</span><span class="method-args">(key, default)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000139-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000139-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 39</span>
-39: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
-40: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
-41: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
-42: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000136" class="method-detail">
- <a name="M000136"></a>
-
- <div class="method-heading">
- <a href="#M000136" class="method-signature">
- <span class="method-name">include?</span><span class="method-args">(key)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-If data is a hash, quick helper to get access to it‘s <a
-href="Request.html#M000136">include?</a> method else returns false
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000136-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000136-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 20</span>
-20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
-21: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
-22: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
-23: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000137" class="method-detail">
- <a name="M000137"></a>
-
- <div class="method-heading">
- <a href="#M000137" class="method-signature">
- <span class="method-name">should_respond?</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-If no :process_results is specified always respond else respond based on
-the supplied property
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000137-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000137-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 27</span>
-27: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">should_respond?</span>
-28: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">:process_results</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:process_results</span>)
-29:
-30: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-31: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000140" class="method-detail">
- <a name="M000140"></a>
-
- <div class="method-heading">
- <a href="#M000140" class="method-signature">
- <span class="method-name">to_hash</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000140-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000140-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 44</span>
-44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
-45: <span class="ruby-keyword kw">return</span> {<span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@agent</span>,
-46: <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@action</span>,
-47: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@data</span>}
-48: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000142" class="method-detail">
- <a name="M000142"></a>
-
- <div class="method-heading">
- <a href="#M000142" class="method-signature">
- <span class="method-name">to_json</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000142-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000142-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 55</span>
-55: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_json</span>
-56: <span class="ruby-identifier">to_hash</span>.<span class="ruby-identifier">merge!</span>({<span class="ruby-identifier">:sender</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@sender</span>,
-57: <span class="ruby-identifier">:callerid</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@callerid</span>,
-58: <span class="ruby-identifier">:uniqid</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@uniqid</span>}).<span class="ruby-identifier">to_json</span>
-59: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000141" class="method-detail">
- <a name="M000141"></a>
-
- <div class="method-heading">
- <a href="#M000141" class="method-signature">
- <span class="method-name">validate!</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Validate the request against the <a href="../DDL.html">DDL</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000141-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000141-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/request.rb, line 51</span>
-51: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate!</span>
-52: <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">validate_rpc_request</span>(<span class="ruby-ivar">@action</span>, <span class="ruby-ivar">@data</span>)
-53: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::RPC::Result</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPC::Result</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/rpc/result_rb.html">
- lib/mcollective/rpc/result.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Simple class to manage compliant results from <a
-href="../RPC.html">MCollective::RPC</a> agents
-</p>
-<p>
-Currently it just fakes Hash behaviour to the result to remain backward
-compatible but it also knows which agent and action produced it so you can
-associate results to a <a href="../DDL.html">DDL</a>
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000054">[]</a>
- <a href="#M000055">[]=</a>
- <a href="#M000057">each</a>
- <a href="#M000056">fetch</a>
- <a href="#M000053">new</a>
- <a href="#M000058">to_json</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
- <div id="includes">
- <h3 class="section-bar">Included Modules</h3>
-
- <div id="includes-list">
- <span class="include-name">Enumerable</span>
- </div>
- </div>
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">action</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">agent</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">results</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000053" class="method-detail">
- <a name="M000053"></a>
-
- <div class="method-heading">
- <a href="#M000053" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(agent, action, result={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000053-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000053-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 13</span>
-13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">result</span>={})
-14: <span class="ruby-ivar">@agent</span> = <span class="ruby-identifier">agent</span>
-15: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
-16: <span class="ruby-ivar">@results</span> = <span class="ruby-identifier">result</span>
-17: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000054" class="method-detail">
- <a name="M000054"></a>
-
- <div class="method-heading">
- <a href="#M000054" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(idx)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000054-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000054-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 19</span>
-19: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">idx</span>)
-20: <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">idx</span>]
-21: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000055" class="method-detail">
- <a name="M000055"></a>
-
- <div class="method-heading">
- <a href="#M000055" class="method-signature">
- <span class="method-name">[]=</span><span class="method-args">(idx, item)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000055-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000055-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 23</span>
-23: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">idx</span>, <span class="ruby-identifier">item</span>)
-24: <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">idx</span>] = <span class="ruby-identifier">item</span>
-25: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000057" class="method-detail">
- <a name="M000057"></a>
-
- <div class="method-heading">
- <a href="#M000057" class="method-signature">
- <span class="method-name">each</span><span class="method-args">() {|k,v| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000057-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000057-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 31</span>
-31: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span>
-32: <span class="ruby-ivar">@results</span>.<span class="ruby-identifier">each_pair</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span>) }
-33: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000056" class="method-detail">
- <a name="M000056"></a>
-
- <div class="method-heading">
- <a href="#M000056" class="method-signature">
- <span class="method-name">fetch</span><span class="method-args">(key, default)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000056-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000056-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 27</span>
-27: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
-28: <span class="ruby-ivar">@results</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
-29: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000058" class="method-detail">
- <a name="M000058"></a>
-
- <div class="method-heading">
- <a href="#M000058" class="method-signature">
- <span class="method-name">to_json</span><span class="method-args">(*a)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000058-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000058-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/rpc/result.rb, line 35</span>
-35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_json</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">a</span>)
-36: {<span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@agent</span>,
-37: <span class="ruby-identifier">:action</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@action</span>,
-38: <span class="ruby-identifier">:sender</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">:sender</span>],
-39: <span class="ruby-identifier">:statuscode</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">:statuscode</span>],
-40: <span class="ruby-identifier">:statusmsg</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">:statusmsg</span>],
-41: <span class="ruby-identifier">:data</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@results</span>[<span class="ruby-identifier">:data</span>]}.<span class="ruby-identifier">to_json</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">a</span>)
-42: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::RPCAborted</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPCAborted</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="RPCError.html">
- RPCError
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::RPCError</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RPCError</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- StandardError
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::Registration</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Registration</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/registration/base_rb.html">
- lib/mcollective/registration/base.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/registration_rb.html">
- lib/mcollective/registration.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-<a href="Registration.html">Registration</a> is implimented using a module
-structure and installations can configure which module they want to use.
-</p>
-<p>
-We provide a simple one that just sends back the list of current known
-agents in MCollective::Registration::Agentlist, you can create your own:
-</p>
-<p>
-Create a module in plugins/mcollective/registration/<yourplugin>.rb
-</p>
-<p>
-You can inherit from <a
-href="Registration/Base.html">MCollective::Registration::Base</a> in which
-case you just need to supply a <em>body</em> method, whatever this method
-returns will be send to the middleware connection for an agent called
-<em>registration</em>
-</p>
-
- </div>
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Class <a href="Registration/Base.html" class="link">MCollective::Registration::Base</a><br />
-
- </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Registration::Base</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Registration::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/registration/base_rb.html">
- lib/mcollective/registration/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-This is a base class that other registration plugins can use to handle
-regular announcements to the mcollective
-</p>
-<p>
-The configuration file determines how often registration messages gets sent
-using the <em>registerinterval</em> option, the plugin runs in the
-background in a thread.
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000192">config</a>
- <a href="#M000190">inherited</a>
- <a href="#M000195">interval</a>
- <a href="#M000193">msg_filter</a>
- <a href="#M000196">publish</a>
- <a href="#M000191">run</a>
- <a href="#M000194">target_collective</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000190" class="method-detail">
- <a name="M000190"></a>
-
- <div class="method-heading">
- <a href="#M000190" class="method-signature">
- <span class="method-name">inherited</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Register plugins that inherits base
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000190-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000190-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 11</span>
-11: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
-12: <span class="ruby-constant">PluginManager</span> <span class="ruby-operator"><<</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"registration_plugin"</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>}
-13: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000192" class="method-detail">
- <a name="M000192"></a>
-
- <div class="method-heading">
- <a href="#M000192" class="method-signature">
- <span class="method-name">config</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000192-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000192-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 36</span>
-36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">config</span>
-37: <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
-38: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000195" class="method-detail">
- <a name="M000195"></a>
-
- <div class="method-heading">
- <a href="#M000195" class="method-signature">
- <span class="method-name">interval</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000195-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000195-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 59</span>
-59: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">interval</span>
-60: <span class="ruby-identifier">config</span>.<span class="ruby-identifier">registerinterval</span>
-61: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000193" class="method-detail">
- <a name="M000193"></a>
-
- <div class="method-heading">
- <a href="#M000193" class="method-signature">
- <span class="method-name">msg_filter</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000193-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000193-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 40</span>
-40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">msg_filter</span>
-41: <span class="ruby-identifier">filter</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter</span>
-42: <span class="ruby-identifier">filter</span>[<span class="ruby-value str">"agent"</span>] <span class="ruby-operator"><<</span> <span class="ruby-value str">"registration"</span>
-43: <span class="ruby-identifier">filter</span>
-44: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000196" class="method-detail">
- <a name="M000196"></a>
-
- <div class="method-heading">
- <a href="#M000196" class="method-signature">
- <span class="method-name">publish</span><span class="method-args">(message)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000196-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000196-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 63</span>
-63: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">publish</span>(<span class="ruby-identifier">message</span>)
-64: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">message</span>
-65: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Skipping registration due to nil body"</span>)
-66: <span class="ruby-keyword kw">else</span>
-67: <span class="ruby-identifier">req</span> = <span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">message</span>, <span class="ruby-keyword kw">nil</span>, {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:request</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"registration"</span>, <span class="ruby-identifier">:collective</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">target_collective</span>, <span class="ruby-identifier">:filter</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">msg_filter</span>})
-68: <span class="ruby-identifier">req</span>.<span class="ruby-identifier">encode!</span>
-69:
-70: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Sending registration #{req.requestid} to collective #{req.collective}"</span>)
-71:
-72: <span class="ruby-identifier">req</span>.<span class="ruby-identifier">publish</span>
-73: <span class="ruby-keyword kw">end</span>
-74: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000191" class="method-detail">
- <a name="M000191"></a>
-
- <div class="method-heading">
- <a href="#M000191" class="method-signature">
- <span class="method-name">run</span><span class="method-args">(connection)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates a background thread that periodically send a registration notice.
-</p>
-<p>
-The actual registration notices comes from the ‘body’ method of
-the registration plugins.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000191-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000191-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 19</span>
-19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>(<span class="ruby-identifier">connection</span>)
-20: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">interval</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
-21:
-22: <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span>
-23: <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
-24: <span class="ruby-keyword kw">begin</span>
-25: <span class="ruby-identifier">publish</span>(<span class="ruby-identifier">body</span>)
-26:
-27: <span class="ruby-identifier">sleep</span> <span class="ruby-identifier">interval</span>
-28: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-29: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Sending registration message failed: #{e}"</span>)
-30: <span class="ruby-identifier">sleep</span> <span class="ruby-identifier">interval</span>
-31: <span class="ruby-keyword kw">end</span>
-32: <span class="ruby-keyword kw">end</span>
-33: <span class="ruby-keyword kw">end</span>
-34: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000194" class="method-detail">
- <a name="M000194"></a>
-
- <div class="method-heading">
- <a href="#M000194" class="method-signature">
- <span class="method-name">target_collective</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000194-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000194-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 46</span>
-46: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">target_collective</span>
-47: <span class="ruby-identifier">main_collective</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">main_collective</span>
-48:
-49: <span class="ruby-identifier">collective</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">registration_collective</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">main_collective</span>
-50:
-51: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">collectives</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">collective</span>)
-52: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Sending registration to #{main_collective}: #{collective} is not a valid collective"</span>)
-53: <span class="ruby-identifier">collective</span> = <span class="ruby-identifier">main_collective</span>
-54: <span class="ruby-keyword kw">end</span>
-55:
-56: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">collective</span>
-57: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Runner</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Runner</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/runner_rb.html">
- lib/mcollective/runner.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-The main runner for the daemon, supports running in the foreground and the
-background, keeps detailed stats and provides hooks to access all this
-information
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000496">new</a>
- <a href="#M000497">run</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
- <div id="includes">
- <h3 class="section-bar">Included Modules</h3>
-
- <div id="includes-list">
- <span class="include-name"><a href="Translatable.html">Translatable</a></span>
- </div>
- </div>
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000496" class="method-detail">
- <a name="M000496"></a>
-
- <div class="method-heading">
- <a href="#M000496" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(configfile)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000496-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000496-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/runner.rb, line 8</span>
- 8: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">configfile</span>)
- 9: <span class="ruby-ivar">@config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
-10: <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">loadconfig</span>(<span class="ruby-identifier">configfile</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">configured</span>
-11: <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">mode</span> = <span class="ruby-identifier">:server</span>
-12:
-13: <span class="ruby-ivar">@stats</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"global_stats"</span>]
-14:
-15: <span class="ruby-ivar">@security</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"security_plugin"</span>]
-16: <span class="ruby-ivar">@security</span>.<span class="ruby-identifier">initiated_by</span> = <span class="ruby-identifier">:node</span>
-17:
-18: <span class="ruby-ivar">@connection</span> = <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"connector_plugin"</span>]
-19: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">connect</span>
-20:
-21: <span class="ruby-ivar">@agents</span> = <span class="ruby-constant">Agents</span>.<span class="ruby-identifier">new</span>
-22:
-23: <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
-24: <span class="ruby-constant">Signal</span>.<span class="ruby-identifier">trap</span>(<span class="ruby-value str">"USR1"</span>) <span class="ruby-keyword kw">do</span>
-25: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC2</span>, <span class="ruby-value str">"Reloading all agents after receiving USR1 signal"</span>, <span class="ruby-identifier">:info</span>)
-26: <span class="ruby-ivar">@agents</span>.<span class="ruby-identifier">loadagents</span>
-27: <span class="ruby-keyword kw">end</span>
-28:
-29: <span class="ruby-constant">Signal</span>.<span class="ruby-identifier">trap</span>(<span class="ruby-value str">"USR2"</span>) <span class="ruby-keyword kw">do</span>
-30: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC3</span>, <span class="ruby-value str">"Cycling logging level due to USR2 signal"</span>, <span class="ruby-identifier">:info</span>)
-31:
-32: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">cycle_level</span>
-33: <span class="ruby-keyword kw">end</span>
-34: <span class="ruby-keyword kw">else</span>
-35: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">setup_windows_sleeper</span>
-36: <span class="ruby-keyword kw">end</span>
-37: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000497" class="method-detail">
- <a name="M000497"></a>
-
- <div class="method-heading">
- <a href="#M000497" class="method-signature">
- <span class="method-name">run</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Starts the main loop, before calling this you should initialize the <a
-href="Config.html">MCollective::Config</a> singleton.
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000497-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000497-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/runner.rb, line 40</span>
-40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>
-41: <span class="ruby-constant">Data</span>.<span class="ruby-identifier">load_data_sources</span>
-42:
-43: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-constant">Util</span>.<span class="ruby-identifier">make_subscriptions</span>(<span class="ruby-value str">"mcollective"</span>, <span class="ruby-identifier">:broadcast</span>))
-44: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-constant">Util</span>.<span class="ruby-identifier">make_subscriptions</span>(<span class="ruby-value str">"mcollective"</span>, <span class="ruby-identifier">:directed</span>)) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">direct_addressing</span>
-45:
-46: <span class="ruby-comment cmt"># Start the registration plugin if interval isn't 0</span>
-47: <span class="ruby-keyword kw">begin</span>
-48: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"registration_plugin"</span>].<span class="ruby-identifier">run</span>(<span class="ruby-ivar">@connection</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">registerinterval</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
-49: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-50: <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">:PLMC4</span>, <span class="ruby-value str">"Failed to start registration plugin: %{error}"</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">e</span>)
-51: <span class="ruby-keyword kw">end</span>
-52:
-53: <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
-54: <span class="ruby-keyword kw">begin</span>
-55: <span class="ruby-identifier">request</span> = <span class="ruby-identifier">receive</span>
-56:
-57: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">request</span>.<span class="ruby-identifier">agent</span> <span class="ruby-operator">==</span> <span class="ruby-value str">"mcollective"</span>
-58: <span class="ruby-identifier">agentmsg</span>(<span class="ruby-identifier">request</span>)
-59: <span class="ruby-keyword kw">else</span>
-60: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC5</span>, <span class="ruby-value str">"Received a control message, possibly via 'mco controller' but this has been deprecated"</span>, <span class="ruby-identifier">:error</span>)
-61: <span class="ruby-keyword kw">end</span>
-62: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">SignalException</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-63: <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">:PLMC7</span>, <span class="ruby-value str">"Exiting after signal: %{error}"</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">e</span>)
-64: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">disconnect</span>
-65: <span class="ruby-identifier">raise</span>
-66:
-67: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">MsgTTLExpired</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-68: <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">:PLMC9</span>, <span class="ruby-value str">"Expired Message: %{error}"</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">e</span>)
-69:
-70: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NotTargettedAtUs</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-71: <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">:PLMC6</span>, <span class="ruby-value str">"Message does not pass filters, ignoring"</span>, <span class="ruby-identifier">:debug</span>)
-72:
-73: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-74: <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">:PLMC10</span>, <span class="ruby-value str">"Failed to handle message: %{error}"</span>, <span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">e</span>, <span class="ruby-keyword kw">true</span>)
-75: <span class="ruby-keyword kw">end</span>
-76: <span class="ruby-keyword kw">end</span>
-77: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::RunnerStats</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::RunnerStats</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/runnerstats_rb.html">
- lib/mcollective/runnerstats.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Class to store stats about the mcollectived, it should live in the <a
-href="PluginManager.html">PluginManager</a> so that agents etc can get hold
-of it and return the stats to callers
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000476">filtered</a>
- <a href="#M000473">new</a>
- <a href="#M000475">passed</a>
- <a href="#M000479">received</a>
- <a href="#M000480">sent</a>
- <a href="#M000481">to_hash</a>
- <a href="#M000474">ttlexpired</a>
- <a href="#M000478">unvalidated</a>
- <a href="#M000477">validated</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000473" class="method-detail">
- <a name="M000473"></a>
-
- <div class="method-heading">
- <a href="#M000473" class="method-signature">
- <span class="method-name">new</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000473-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000473-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 5</span>
- 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
- 6: <span class="ruby-ivar">@starttime</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>
- 7: <span class="ruby-ivar">@validated</span> = <span class="ruby-value">0</span>
- 8: <span class="ruby-ivar">@unvalidated</span> = <span class="ruby-value">0</span>
- 9: <span class="ruby-ivar">@filtered</span> = <span class="ruby-value">0</span>
-10: <span class="ruby-ivar">@passed</span> = <span class="ruby-value">0</span>
-11: <span class="ruby-ivar">@total</span> = <span class="ruby-value">0</span>
-12: <span class="ruby-ivar">@replies</span> = <span class="ruby-value">0</span>
-13: <span class="ruby-ivar">@ttlexpired</span> = <span class="ruby-value">0</span>
-14:
-15: <span class="ruby-ivar">@mutex</span> = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
-16: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000476" class="method-detail">
- <a name="M000476"></a>
-
- <div class="method-heading">
- <a href="#M000476" class="method-signature">
- <span class="method-name">filtered</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Records a message that didnt pass the filters
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000476-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000476-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 31</span>
-31: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">filtered</span>
-32: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing filtered stat"</span>)
-33: <span class="ruby-ivar">@filtered</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
-34: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000475" class="method-detail">
- <a name="M000475"></a>
-
- <div class="method-heading">
- <a href="#M000475" class="method-signature">
- <span class="method-name">passed</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Records a message that <a href="RunnerStats.html#M000475">passed</a> the
-filters
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000475-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000475-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 25</span>
-25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">passed</span>
-26: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing passed stat"</span>)
-27: <span class="ruby-ivar">@passed</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
-28: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000479" class="method-detail">
- <a name="M000479"></a>
-
- <div class="method-heading">
- <a href="#M000479" class="method-signature">
- <span class="method-name">received</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Records receipt of a message
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000479-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000479-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 48</span>
-48: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">received</span>
-49: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing total stat"</span>)
-50: <span class="ruby-ivar">@total</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
-51: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000480" class="method-detail">
- <a name="M000480"></a>
-
- <div class="method-heading">
- <a href="#M000480" class="method-signature">
- <span class="method-name">sent</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Records sending a message
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000480-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000480-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 54</span>
-54: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sent</span>
-55: <span class="ruby-ivar">@mutex</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
-56: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing replies stat"</span>)
-57: <span class="ruby-ivar">@replies</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
-58: <span class="ruby-keyword kw">end</span>
-59: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000481" class="method-detail">
- <a name="M000481"></a>
-
- <div class="method-heading">
- <a href="#M000481" class="method-signature">
- <span class="method-name">to_hash</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns a hash with all stats
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000481-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000481-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 62</span>
-62: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
-63: <span class="ruby-identifier">stats</span> = {<span class="ruby-identifier">:validated</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@validated</span>,
-64: <span class="ruby-identifier">:unvalidated</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@unvalidated</span>,
-65: <span class="ruby-identifier">:passed</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@passed</span>,
-66: <span class="ruby-identifier">:filtered</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@filtered</span>,
-67: <span class="ruby-identifier">:starttime</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@starttime</span>,
-68: <span class="ruby-identifier">:total</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@total</span>,
-69: <span class="ruby-identifier">:ttlexpired</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@ttlexpired</span>,
-70: <span class="ruby-identifier">:replies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@replies</span>}
-71:
-72: <span class="ruby-identifier">reply</span> = {<span class="ruby-identifier">:stats</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">stats</span>,
-73: <span class="ruby-identifier">:threads</span> =<span class="ruby-operator">></span> [],
-74: <span class="ruby-identifier">:pid</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Process</span>.<span class="ruby-identifier">pid</span>,
-75: <span class="ruby-identifier">:times</span> =<span class="ruby-operator">></span> {} }
-76:
-77: <span class="ruby-operator">::</span><span class="ruby-constant">Process</span>.<span class="ruby-identifier">times</span>.<span class="ruby-identifier">each_pair</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
-78: <span class="ruby-identifier">k</span> = <span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_sym</span>
-79: <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:times</span>][<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">v</span>
-80: }
-81:
-82: <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">list</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span>
-83: <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:threads</span>] <span class="ruby-operator"><<</span> <span class="ruby-node">"#{t.inspect}"</span>
-84: <span class="ruby-keyword kw">end</span>
-85:
-86: <span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:agents</span>] = <span class="ruby-constant">Agents</span>.<span class="ruby-identifier">agentlist</span>
-87: <span class="ruby-identifier">reply</span>
-88: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000474" class="method-detail">
- <a name="M000474"></a>
-
- <div class="method-heading">
- <a href="#M000474" class="method-signature">
- <span class="method-name">ttlexpired</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Records a message that failed TTL checks
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000474-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000474-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 19</span>
-19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ttlexpired</span>
-20: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing ttl expired stat"</span>)
-21: <span class="ruby-ivar">@ttlexpired</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
-22: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000478" class="method-detail">
- <a name="M000478"></a>
-
- <div class="method-heading">
- <a href="#M000478" class="method-signature">
- <span class="method-name">unvalidated</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000478-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000478-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 42</span>
-42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unvalidated</span>
-43: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing unvalidated stat"</span>)
-44: <span class="ruby-ivar">@unvalidated</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
-45: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000477" class="method-detail">
- <a name="M000477"></a>
-
- <div class="method-heading">
- <a href="#M000477" class="method-signature">
- <span class="method-name">validated</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Records a message that <a href="RunnerStats.html#M000477">validated</a> ok
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000477-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000477-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/runnerstats.rb, line 37</span>
-37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validated</span>
-38: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Incrementing validated stat"</span>)
-39: <span class="ruby-ivar">@validated</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
-40: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::Security</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Security</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/security_rb.html">
- lib/mcollective/security.rb
- </a>
- <br />
- <a href="../../files/lib/mcollective/security/base_rb.html">
- lib/mcollective/security/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-<a href="Security.html">Security</a> is implimented using a module
-structure and installations can configure which module they want to use.
-</p>
-<p>
-<a href="Security.html">Security</a> modules deal with various aspects of
-authentication and authorization:
-</p>
-<ul>
-<li>Determines if a filter excludes this host from dealing with a request
-
-</li>
-<li>Serialization and Deserialization of messages
-
-</li>
-<li>Validation of messages against keys, certificates or whatever the class
-choose to impliment
-
-</li>
-<li>Encoding and Decoding of messages
-
-</li>
-</ul>
-<p>
-To impliment a new security class using <a href="SSL.html">SSL</a> for
-example you would inherit from the base class and only impliment:
-</p>
-<ul>
-<li>decodemsg
-
-</li>
-<li>encodereply
-
-</li>
-<li>encoderequest
-
-</li>
-<li>validrequest?
-
-</li>
-</ul>
-<p>
-Each of these methods should increment various stats counters, see the
-default MCollective::Security::Psk module for examples of this
-</p>
-<p>
-Filtering can be extended by providing a new validate_filter? method.
-</p>
-
- </div>
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
- <div id="class-list">
- <h3 class="section-bar">Classes and Modules</h3>
-
- Class <a href="Security/Base.html" class="link">MCollective::Security::Base</a><br />
-
- </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::SecurityValidationFailed</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::SecurityValidationFailed</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- RuntimeError
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Shell</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Shell</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/shell_rb.html">
- lib/mcollective/shell.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Wrapper around systemu that handles executing of system commands in a way
-that makes stdout, stderr and status available. Supports timeouts and sets
-a default sane environment.
-</p>
-<pre>
- s = Shell.new("date", opts)
- s.runcommand
- puts s.stdout
- puts s.stderr
- puts s.status.exitstatus
-</pre>
-<p>
-Options hash can have:
-</p>
-<pre>
- cwd - the working directory the command will be run from
- stdin - a string that will be sent to stdin of the program
- stdout - a variable that will receive stdout, must support <<
- stderr - a variable that will receive stdin, must support <<
- environment - the shell environment, defaults to include LC_ALL=C
- set to nil to clear the environment even of LC_ALL
-</pre>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000371">new</a>
- <a href="#M000372">runcommand</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">command</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">cwd</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">environment</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">status</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">stderr</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">stdin</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">stdout</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000371" class="method-detail">
- <a name="M000371"></a>
-
- <div class="method-heading">
- <a href="#M000371" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(command, options={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000371-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000371-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/shell.rb, line 24</span>
-24: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">options</span>={})
-25: <span class="ruby-ivar">@environment</span> = {<span class="ruby-value str">"LC_ALL"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"C"</span>}
-26: <span class="ruby-ivar">@command</span> = <span class="ruby-identifier">command</span>
-27: <span class="ruby-ivar">@status</span> = <span class="ruby-keyword kw">nil</span>
-28: <span class="ruby-ivar">@stdout</span> = <span class="ruby-value str">""</span>
-29: <span class="ruby-ivar">@stderr</span> = <span class="ruby-value str">""</span>
-30: <span class="ruby-ivar">@stdin</span> = <span class="ruby-keyword kw">nil</span>
-31: <span class="ruby-ivar">@cwd</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">tmpdir</span>
-32:
-33: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opt</span>, <span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
-34: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">opt</span>.<span class="ruby-identifier">to_s</span>
-35: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"stdout"</span>
-36: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"stdout should support <<"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"<<"</span>)
-37: <span class="ruby-ivar">@stdout</span> = <span class="ruby-identifier">val</span>
-38:
-39: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"stderr"</span>
-40: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"stderr should support <<"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"<<"</span>)
-41: <span class="ruby-ivar">@stderr</span> = <span class="ruby-identifier">val</span>
-42:
-43: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"stdin"</span>
-44: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"stdin should be a String"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
-45: <span class="ruby-ivar">@stdin</span> = <span class="ruby-identifier">val</span>
-46:
-47: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"cwd"</span>
-48: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Directory #{val} does not exist"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">val</span>)
-49: <span class="ruby-ivar">@cwd</span> = <span class="ruby-identifier">val</span>
-50:
-51: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"environment"</span>
-52: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">nil?</span>
-53: <span class="ruby-ivar">@environment</span> = {}
-54: <span class="ruby-keyword kw">else</span>
-55: <span class="ruby-ivar">@environment</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">val</span>.<span class="ruby-identifier">dup</span>)
-56: <span class="ruby-keyword kw">end</span>
-57: <span class="ruby-keyword kw">end</span>
-58: <span class="ruby-keyword kw">end</span>
-59: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000372" class="method-detail">
- <a name="M000372"></a>
-
- <div class="method-heading">
- <a href="#M000372" class="method-signature">
- <span class="method-name">runcommand</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Actually does the systemu call passing in the correct environment, stdout
-and stderr
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000372-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000372-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/shell.rb, line 62</span>
-62: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">runcommand</span>
-63: <span class="ruby-identifier">opts</span> = {<span class="ruby-value str">"env"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@environment</span>,
-64: <span class="ruby-value str">"stdout"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@stdout</span>,
-65: <span class="ruby-value str">"stderr"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@stderr</span>,
-66: <span class="ruby-value str">"cwd"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@cwd</span>}
-67:
-68: <span class="ruby-identifier">opts</span>[<span class="ruby-value str">"stdin"</span>] = <span class="ruby-ivar">@stdin</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@stdin</span>
-69:
-70: <span class="ruby-comment cmt"># Check if the parent thread is alive. If it should die,</span>
-71: <span class="ruby-comment cmt"># and the process spawned by systemu is still alive,</span>
-72: <span class="ruby-comment cmt"># fire off a blocking waitpid and wait for the process to</span>
-73: <span class="ruby-comment cmt"># finish so that we can avoid zombies.</span>
-74: <span class="ruby-identifier">thread</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>
-75: <span class="ruby-ivar">@status</span> = <span class="ruby-identifier">systemu</span>(<span class="ruby-ivar">@command</span>, <span class="ruby-identifier">opts</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">cid</span><span class="ruby-operator">|</span>
-76: <span class="ruby-keyword kw">begin</span>
-77: <span class="ruby-keyword kw">while</span>(<span class="ruby-identifier">thread</span>.<span class="ruby-identifier">alive?</span>)
-78: <span class="ruby-identifier">sleep</span> <span class="ruby-value">0</span><span class="ruby-value">.1</span>
-79: <span class="ruby-keyword kw">end</span>
-80:
-81: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">waitpid</span>(<span class="ruby-identifier">cid</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Process</span>.<span class="ruby-identifier">getpgid</span>(<span class="ruby-identifier">cid</span>)
-82: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">SystemExit</span>
-83: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ESRCH</span>
-84: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ECHILD</span>
-85: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-86: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">"Unexpected exception received while waiting for child process: #{e.class}: #{e}"</span>)
-87: <span class="ruby-keyword kw">end</span>
-88: <span class="ruby-keyword kw">end</span>
-89: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::Translatable</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Translatable</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/translatable_rb.html">
- lib/mcollective/translatable.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000246">log_code</a>
- <a href="#M000248">logexception</a>
- <a href="#M000247">raise_code</a>
- <a href="#M000245">t</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000246" class="method-detail">
- <a name="M000246"></a>
-
- <div class="method-heading">
- <a href="#M000246" class="method-signature">
- <span class="method-name">log_code</span><span class="method-args">(msgid, default, level, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000246-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000246-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 7</span>
- 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log_code</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>={})
- 8: <span class="ruby-identifier">msg</span> = <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">msgid</span>, <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))]
- 9:
-10: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">caller</span>[<span class="ruby-value">1</span>]))
-11: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000248" class="method-detail">
- <a name="M000248"></a>
-
- <div class="method-heading">
- <a href="#M000248" class="method-signature">
- <span class="method-name">logexception</span><span class="method-args">(msgid, default, level, e, backtrace=false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000248-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000248-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 20</span>
-20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">e</span>, <span class="ruby-identifier">backtrace</span>=<span class="ruby-keyword kw">false</span>)
-21: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">e</span>, <span class="ruby-identifier">backtrace</span>)
-22: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000247" class="method-detail">
- <a name="M000247"></a>
-
- <div class="method-heading">
- <a href="#M000247" class="method-signature">
- <span class="method-name">raise_code</span><span class="method-args">(msgid, default, level, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000247-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000247-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 13</span>
-13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>={})
-14: <span class="ruby-identifier">exception</span> = <span class="ruby-constant">CodedError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>)
-15: <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">set_backtrace</span> <span class="ruby-identifier">caller</span>
-16:
-17: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">exception</span>
-18: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000245" class="method-detail">
- <a name="M000245"></a>
-
- <div class="method-heading">
- <a href="#M000245" class="method-signature">
- <span class="method-name">t</span><span class="method-args">(msgid, default, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000245-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000245-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/translatable.rb, line 3</span>
-3: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">args</span>={})
-4: <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))
-5: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::UnixDaemon</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::UnixDaemon</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/unix_daemon_rb.html">
- lib/mcollective/unix_daemon.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000423">daemonize</a>
- <a href="#M000424">daemonize_runner</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000423" class="method-detail">
- <a name="M000423"></a>
-
- <div class="method-heading">
- <a href="#M000423" class="method-signature">
- <span class="method-name">daemonize</span><span class="method-args">() {|| ...}</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Daemonize the current process
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000423-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000423-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/unix_daemon.rb, line 4</span>
- 4: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">daemonize</span>
- 5: <span class="ruby-identifier">fork</span> <span class="ruby-keyword kw">do</span>
- 6: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">setsid</span>
- 7: <span class="ruby-identifier">exit</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">fork</span>
- 8: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-value str">'/tmp'</span>)
- 9: <span class="ruby-constant">STDIN</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-value str">'/dev/null'</span>)
-10: <span class="ruby-constant">STDOUT</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-value str">'/dev/null'</span>, <span class="ruby-value str">'a'</span>)
-11: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-value str">'/dev/null'</span>, <span class="ruby-value str">'a'</span>)
-12:
-13: <span class="ruby-keyword kw">yield</span>
-14: <span class="ruby-keyword kw">end</span>
-15: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000424" class="method-detail">
- <a name="M000424"></a>
-
- <div class="method-heading">
- <a href="#M000424" class="method-signature">
- <span class="method-name">daemonize_runner</span><span class="method-args">(pid=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000424-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000424-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/unix_daemon.rb, line 17</span>
-17: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">daemonize_runner</span>(<span class="ruby-identifier">pid</span>=<span class="ruby-keyword kw">nil</span>)
-18: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"The Unix Daemonizer can not be used on the Windows Platform"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
-19:
-20: <span class="ruby-constant">UnixDaemon</span>.<span class="ruby-identifier">daemonize</span> <span class="ruby-keyword kw">do</span>
-21: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span>
-22: <span class="ruby-keyword kw">begin</span>
-23: <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">pid</span>, <span class="ruby-value str">'w'</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-constant">Process</span>.<span class="ruby-identifier">pid</span>) }
-24: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-25: <span class="ruby-keyword kw">end</span>
-26: <span class="ruby-keyword kw">end</span>
-27:
-28: <span class="ruby-keyword kw">begin</span>
-29: <span class="ruby-identifier">runner</span> = <span class="ruby-constant">Runner</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">nil</span>)
-30: <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">run</span>
-31: <span class="ruby-keyword kw">ensure</span>
-32: <span class="ruby-constant">File</span>.<span class="ruby-identifier">unlink</span>(<span class="ruby-identifier">pid</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">pid</span>)
-33: <span class="ruby-keyword kw">end</span>
-34: <span class="ruby-keyword kw">end</span>
-35: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::UnknownRPCAction</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::UnknownRPCAction</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="RPCError.html">
- RPCError
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::UnknownRPCError</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::UnknownRPCError</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="RPCError.html">
- RPCError
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Module: MCollective::Validator</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Validator</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/validator_rb.html">
- lib/mcollective/validator.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000217">[]</a>
- <a href="#M000219">has_validator?</a>
- <a href="#M000216">load_validators</a>
- <a href="#M000221">load_validators?</a>
- <a href="#M000218">method_missing</a>
- <a href="#M000222">validate</a>
- <a href="#M000220">validator_class</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000217" class="method-detail">
- <a name="M000217"></a>
-
- <div class="method-heading">
- <a href="#M000217" class="method-signature">
- <span class="method-name">[]</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns and instance of the Plugin class from which objects can be created.
-Valid plugin names are
-</p>
-<pre>
- :valplugin
- "valplugin"
- "ValpluginValidator"
-</pre>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000217-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000217-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 18</span>
-18: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">klass</span>)
-19: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Symbol</span>)
-20: <span class="ruby-identifier">klass</span> = <span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">klass</span>)
-21: <span class="ruby-keyword kw">elsif</span> <span class="ruby-operator">!</span>(<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/.*Validator$/</span>))
-22: <span class="ruby-identifier">klass</span> = <span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">klass</span>)
-23: <span class="ruby-keyword kw">end</span>
-24:
-25: <span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">klass</span>)
-26: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000219" class="method-detail">
- <a name="M000219"></a>
-
- <div class="method-heading">
- <a href="#M000219" class="method-signature">
- <span class="method-name">has_validator?</span><span class="method-args">(validator)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000219-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000219-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 37</span>
-37: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_validator?</span>(<span class="ruby-identifier">validator</span>)
-38: <span class="ruby-identifier">const_defined?</span>(<span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">validator</span>))
-39: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000216" class="method-detail">
- <a name="M000216"></a>
-
- <div class="method-heading">
- <a href="#M000216" class="method-signature">
- <span class="method-name">load_validators</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Loads the validator plugins. Validators will only be loaded every 5 minutes
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000216-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000216-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 6</span>
- 6: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_validators</span>
- 7: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">load_validators?</span>
- 8: <span class="ruby-ivar">@last_load</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>
- 9: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find_and_load</span>(<span class="ruby-value str">"validator"</span>)
-10: <span class="ruby-keyword kw">end</span>
-11: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000221" class="method-detail">
- <a name="M000221"></a>
-
- <div class="method-heading">
- <a href="#M000221" class="method-signature">
- <span class="method-name">load_validators?</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000221-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000221-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 45</span>
-45: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_validators?</span>
-46: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@last_load</span>.<span class="ruby-identifier">nil?</span>
-47:
-48: (<span class="ruby-ivar">@last_load</span> <span class="ruby-operator">-</span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_i</span>) <span class="ruby-operator">></span> <span class="ruby-value">300</span>
-49: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000218" class="method-detail">
- <a name="M000218"></a>
-
- <div class="method-heading">
- <a href="#M000218" class="method-signature">
- <span class="method-name">method_missing</span><span class="method-args">(method, *args, &block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Allows validation plugins to be called like module methods : <a
-href="Validator.html#M000222">Validator.validate</a>()
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000218-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000218-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 29</span>
-29: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-30: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">has_validator?</span>(<span class="ruby-identifier">method</span>)
-31: <span class="ruby-identifier">validator</span> = <span class="ruby-constant">Validator</span>[<span class="ruby-identifier">method</span>].<span class="ruby-identifier">validate</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
-32: <span class="ruby-keyword kw">else</span>
-33: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ValidatorError</span>, <span class="ruby-node">"Unknown validator: '#{method}'."</span>
-34: <span class="ruby-keyword kw">end</span>
-35: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000222" class="method-detail">
- <a name="M000222"></a>
-
- <div class="method-heading">
- <a href="#M000222" class="method-signature">
- <span class="method-name">validate</span><span class="method-args">(validator, validation)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Generic <a href="Validator.html#M000222">validate</a> method that will call
-the correct validator plugin based on the type of the validation parameter
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000222-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000222-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 53</span>
-53: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">validate</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
-54: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">load_validators</span>
-55:
-56: <span class="ruby-keyword kw">begin</span>
-57: <span class="ruby-keyword kw">if</span> [<span class="ruby-identifier">:integer</span>, <span class="ruby-identifier">:boolean</span>, <span class="ruby-identifier">:float</span>, <span class="ruby-identifier">:number</span>, <span class="ruby-identifier">:string</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">validation</span>)
-58: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">typecheck</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
-59:
-60: <span class="ruby-keyword kw">else</span>
-61: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">validation</span>
-62: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Regexp</span>,<span class="ruby-constant">String</span>
-63: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">regex</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
-64:
-65: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Symbol</span>
-66: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">validation</span>, <span class="ruby-identifier">validator</span>)
-67:
-68: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Array</span>
-69: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">array</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
-70:
-71: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Class</span>
-72: <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">typecheck</span>(<span class="ruby-identifier">validator</span>, <span class="ruby-identifier">validation</span>)
-73: <span class="ruby-keyword kw">end</span>
-74: <span class="ruby-keyword kw">end</span>
-75: <span class="ruby-keyword kw">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-76: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ValidatorError</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>
-77: <span class="ruby-keyword kw">end</span>
-78: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000220" class="method-detail">
- <a name="M000220"></a>
-
- <div class="method-heading">
- <a href="#M000220" class="method-signature">
- <span class="method-name">validator_class</span><span class="method-args">(validator)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000220-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000220-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/validator.rb, line 41</span>
-41: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">validator_class</span>(<span class="ruby-identifier">validator</span>)
-42: <span class="ruby-node">"#{validator.to_s.capitalize}Validator"</span>
-43: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::ValidatorError</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::ValidatorError</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/exception_rb.html">
- lib/mcollective/exception.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- RuntimeError
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::WindowsDaemon</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::WindowsDaemon</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/windows_daemon_rb.html">
- lib/mcollective/windows_daemon.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Win32::Daemon
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000373">daemonize_runner</a>
- <a href="#M000374">service_main</a>
- <a href="#M000375">service_stop</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000373" class="method-detail">
- <a name="M000373"></a>
-
- <div class="method-heading">
- <a href="#M000373" class="method-signature">
- <span class="method-name">daemonize_runner</span><span class="method-args">(pid=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000373-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000373-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/windows_daemon.rb, line 5</span>
- 5: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">daemonize_runner</span>(<span class="ruby-identifier">pid</span>=<span class="ruby-keyword kw">nil</span>)
- 6: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Writing pid files are not supported on the Windows Platform"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span>
- 7: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"The Windows Daemonizer should only be used on the Windows Platform"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
- 8:
- 9: <span class="ruby-constant">WindowsDaemon</span>.<span class="ruby-identifier">mainloop</span>
-10: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000374" class="method-detail">
- <a name="M000374"></a>
-
- <div class="method-heading">
- <a href="#M000374" class="method-signature">
- <span class="method-name">service_main</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000374-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000374-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/windows_daemon.rb, line 12</span>
-12: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">service_main</span>
-13: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">"Starting Windows Service Daemon"</span>)
-14:
-15: <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">running?</span>
-16: <span class="ruby-constant">Runner</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">nil</span>).<span class="ruby-identifier">run</span>
-17: <span class="ruby-keyword kw">end</span>
-18: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000375" class="method-detail">
- <a name="M000375"></a>
-
- <div class="method-heading">
- <a href="#M000375" class="method-signature">
- <span class="method-name">service_stop</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000375-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000375-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/windows_daemon.rb, line 20</span>
-20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">service_stop</span>
-21: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-value str">"Windows service stopping"</span>)
-22: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: String</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">String</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../files/lib/mcollective/monkey_patches_rb.html">
- lib/mcollective/monkey_patches.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-<a href="String.html#M000009">start_with?</a> was introduced in 1.8.7, we
-need to support 1.8.5 and 1.8.6
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000010">bytes</a>
- <a href="#M000009">start_with?</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000010" class="method-detail">
- <a name="M000010"></a>
-
- <div class="method-heading">
- <a href="#M000010" class="method-signature">
- <span class="method-name">bytes</span><span class="method-args">(&block)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000010-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 63</span>
-63: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">bytes</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-64: <span class="ruby-comment cmt"># This should not be necessary, really ...</span>
-65: <span class="ruby-identifier">require</span> <span class="ruby-value str">'enumerator'</span>
-66: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">to_enum</span>(<span class="ruby-identifier">:each_byte</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">block_given?</span>
-67: <span class="ruby-identifier">each_byte</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
-68: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000009" class="method-detail">
- <a name="M000009"></a>
-
- <div class="method-heading">
- <a href="#M000009" class="method-signature">
- <span class="method-name">start_with?</span><span class="method-args">(str)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000009-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 4</span>
-4: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start_with?</span>(<span class="ruby-identifier">str</span>)
-5: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-value">0</span> <span class="ruby-operator">..</span> (<span class="ruby-identifier">str</span>.<span class="ruby-identifier">length</span><span class="ruby-operator">-</span><span class="ruby-value">1</span>)] <span class="ruby-operator">==</span> <span class="ruby-identifier">str</span>
-6: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: Symbol</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">Symbol</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../files/lib/mcollective/monkey_patches_rb.html">
- lib/mcollective/monkey_patches.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Make arrays of Symbols sortable
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000014"><=></a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
- <div id="includes">
- <h3 class="section-bar">Included Modules</h3>
-
- <div id="includes-list">
- <span class="include-name">Comparable</span>
- </div>
- </div>
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000014" class="method-detail">
- <a name="M000014"></a>
-
- <div class="method-heading">
- <a href="#M000014" class="method-signature">
- <span class="method-name"><=></span><span class="method-args">(other)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000014-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 13</span>
-13: <span class="ruby-keyword kw">def</span> <span class="ruby-operator"><=></span>(<span class="ruby-identifier">other</span>)
-14: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">to_s</span>
-15: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
-Fri, 08 Nov 2013 12:58:30 +0000
+Fri, 15 Nov 2013 12:53:46 +0000
--- /dev/null
+<?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>File: client.cfg.dist [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+main_collective = mcollective collectives = mcollective libdir =
+/usr/libexec/mcollective logger_type = console loglevel = warn
+</p>
+<p>
+# Plugins securityprovider = psk plugin.psk = unset
+</p>
+<p>
+connector = activemq plugin.activemq.pool.size = 1
+plugin.activemq.pool.1.host = stomp1 plugin.activemq.pool.1.port = 6163
+plugin.activemq.pool.1.user = mcollective plugin.activemq.pool.1.password =
+marionette
+</p>
+<p>
+# Facts factsource = yaml plugin.yaml = /etc/mcollective/facts.yaml
+</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>
+
--- /dev/null
+<?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>File: data-help.erb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+<%= metastring %> QUERY FUNCTION INPUT:
+</p>
+<p>
+% if entities[:data][:input][:query]
+</p>
+<pre>
+ Description: <%= entities[:data][:input][:query][:description] %>
+ Prompt: <%= entities[:data][:input][:query][:prompt] %>
+ Type: <%= entities[:data][:input][:query][:type] %>
+</pre>
+<p>
+% if entities[:data][:input][:query][:type] == :string
+</p>
+<pre>
+ Validation: <%= entities[:data][:input][:query][:validation] %>
+ Length: <%= entities[:data][:input][:query][:maxlength] %>
+</pre>
+<p>
+% elsif entities[:data][:input][:query][:type] == :list
+</p>
+<pre>
+ Valid Values: <%= entities[:data][:input][:query][:list].join(", ") %>
+</pre>
+<p>
+% end % if entities[:data][:input][:query][:default]
+</p>
+<pre>
+ Default Value: <%= entities[:data][:input][:query][:default] %>
+</pre>
+<p>
+% end % else
+</p>
+<pre>
+ This plugin does not take any input
+</pre>
+<p>
+% end
+</p>
+<p>
+QUERY FUNCTION OUTPUT:
+</p>
+<p>
+% entities[:data][:output].keys.sort.each do |output|
+</p>
+<pre>
+ <%= output %>:
+ Description: <%= entities[:data][:output][output][:description] %>
+ Display As: <%= entities[:data][:output][output][:display_as] %>
+</pre>
+<p>
+% end
+</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>
+
--- /dev/null
+<?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>File: discovery-help.erb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+<%= metastring %> DISCOVERY METHOD CAPABILITIES: % [[“Filter based on
+configuration management classes”, :classes], % [“Filter based
+on system facts”, :facts], % [“Filter based on mcollective
+identity”, :identity], % [“Filter based on mcollective
+agents”, :agents], % [“Compound filters combining classes and
+facts”, :compound]].each do |cap| % if
+entities[:discovery][:capabilities].include?(cap.last)
+</p>
+<pre>
+ <%= cap.first %>
+</pre>
+<p>
+% end % end
+</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>
+
--- /dev/null
+<?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>File: facts.yaml.dist [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <hr size="1"></hr><p>
+mcollective: 1
+</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>
+
--- /dev/null
+<?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>File: metadata-help.erb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+<%= meta[:name] %> <%= “=” * meta[:name].size %>
+</p>
+<p>
+<%= meta[:description] %>
+</p>
+<pre>
+ Author: <%= meta[:author] %>
+ Version: <%= meta[:version] %>
+ License: <%= meta[:license] %>
+ Timeout: <%= meta[:timeout] %>
+ Home Page: <%= meta[:url] %>
+</pre>
+<p>
+% if requirements[:mcollective]
+</p>
+<pre>
+ Requires MCollective <%= requirements[:mcollective] %> or newer
+</pre>
+<p>
+% end % unless @usage == ““
+</p>
+<p>
+<%= Util.align_text(@usage, nil, 3) if @usage != “” %> % end
+</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>
+
--- /dev/null
+<?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>File: msg-help.erb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+Help for message: <%= msg_code %>
+</p>
+<p>
+Example Message:
+</p>
+<p>
+<%= Util.align_text(msg_example, nil, 3) %>
+</p>
+<p>
+Message Detail:
+</p>
+<p>
+<%= Util.align_text(msg_detail, nil, 3) %>
+</p>
+<p>
+For more information please see <a
+href="http://docs.puppetlabs.com/mcollective/messages/">docs.puppetlabs.com/mcollective/messages/</a><%=
+msg_code %>.html
+</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>
+
--- /dev/null
+<?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>File: rpc-help.erb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+<%= metastring %> ACTIONS:
+</p>
+<h6>==</h6>
+<pre>
+ <%= entities.keys.sort.join(", ") %>
+</pre>
+<p>
+% entities.keys.sort.each do |action|
+</p>
+<pre>
+ <%= action %> action:
+ <% (action.size + 8).times do %>-<% end %>
+ <%= entities[action][:description] %>
+
+ INPUT:
+</pre>
+<p>
+% if entities[action][:input].size > 0 %
+entities[action][:input].keys.sort.each do |input|
+</p>
+<pre>
+ <%= input %>:
+ Description: <%= entities[action][:input][input][:description] %>
+ Prompt: <%= entities[action][:input][input][:prompt] %>
+ Type: <%= entities[action][:input][input][:type] %>
+ Optional: <%= !!entities[action][:input][input][:optional] %>
+</pre>
+<p>
+% if entities[action][:input][input][:type] == :string
+</p>
+<pre>
+ Validation: <%= entities[action][:input][input][:validation] %>
+ Length: <%= entities[action][:input][input][:maxlength] %>
+</pre>
+<p>
+% elsif entities[action][:input][input][:type] == :list
+</p>
+<pre>
+ Valid Values: <%= entities[action][:input][input][:list].join(", ") %>
+</pre>
+<p>
+% end % if entities[action][:input][input][:default]
+</p>
+<pre>
+ Default Value: <%= entities[action][:input][input][:default] %>
+</pre>
+<p>
+% end
+</p>
+<p>
+% end % else
+</p>
+<pre>
+ This action does not have any inputs
+</pre>
+<p>
+% end
+</p>
+<pre>
+ OUTPUT:
+</pre>
+<p>
+% entities[action][:output].keys.sort.each do |output|
+</p>
+<pre>
+ <%= output %>:
+ Description: <%= entities[action][:output][output][:description] %>
+ Display As: <%= entities[action][:output][output][:display_as] %>
+</pre>
+<p>
+% if entities[action][:output][output][:default]
+</p>
+<pre>
+ Default Value: <%= entities[action][:output][output][:default] %>
+</pre>
+<p>
+% end
+</p>
+<p>
+% end % end
+</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>
+
--- /dev/null
+<?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>File: server.cfg.dist [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+main_collective = mcollective collectives = mcollective libdir =
+/usr/libexec/mcollective logfile = /var/log/mcollective.log loglevel = info
+daemonize = 1
+</p>
+<p>
+# Plugins securityprovider = psk plugin.psk = unset
+</p>
+<p>
+connector = activemq plugin.activemq.pool.size = 1
+plugin.activemq.pool.1.host = stomp1 plugin.activemq.pool.1.port = 6163
+plugin.activemq.pool.1.user = mcollective plugin.activemq.pool.1.password =
+marionette
+</p>
+<p>
+# Facts factsource = yaml plugin.yaml = /etc/mcollective/facts.yaml
+</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>
+
--- /dev/null
+<?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>File: PLACEHOLDER [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+
+ </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>
+
--- /dev/null
+<?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>File: PLACEHOLDER [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+
+ </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>
+
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: agent.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>agent.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/agent.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: agents.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>agents.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/agents.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: base.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>base.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/aggregate/base.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: base.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>base.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/aggregate/result/base.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: collection_result.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>collection_result.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/aggregate/result/collection_result.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: numeric_result.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>numeric_result.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/aggregate/result/numeric_result.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: result.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>result.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/aggregate/result.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: aggregate.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>aggregate.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/aggregate.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: application.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>application.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/application.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: applications.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>applications.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/applications.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: cache.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>cache.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/cache.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: client.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>client.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/client.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: config.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>config.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/config.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: base.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>base.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/connector/base.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: connector.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>connector.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/connector.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: base.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>base.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/data/base.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: result.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>result.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/data/result.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: data.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>data.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/data.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: agentddl.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>agentddl.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/ddl/agentddl.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: base.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>base.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/ddl/base.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: dataddl.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>dataddl.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/ddl/dataddl.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: discoveryddl.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>discoveryddl.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/ddl/discoveryddl.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: validatorddl.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>validatorddl.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/ddl/validatorddl.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: ddl.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>ddl.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/ddl.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: discovery.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>discovery.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/discovery.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: exception.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>exception.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/exception.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: base.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>base.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/facts/base.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: facts.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>facts.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/facts.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: agent_generator.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>agent_generator.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/generators/agent_generator.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: base.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>base.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/generators/base.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: data_generator.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>data_generator.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/generators/data_generator.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: generators.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>generators.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/generators.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: log.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>log.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/log.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
- <div id="requires-list">
- <h3 class="section-bar">Required files</h3>
-
- <div class="name-list">
- mcollective/logger/%s_logger
- </div>
- </div>
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: base.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>base.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/logger/base.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: console_logger.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>console_logger.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/logger/console_logger.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: file_logger.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>file_logger.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/logger/file_logger.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
- <div id="requires-list">
- <h3 class="section-bar">Required files</h3>
-
- <div class="name-list">
- logger
- </div>
- </div>
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: syslog_logger.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>syslog_logger.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/logger/syslog_logger.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
- <div id="requires-list">
- <h3 class="section-bar">Required files</h3>
-
- <div class="name-list">
- syslog
- </div>
- </div>
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: logger.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>logger.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/logger.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: parser.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>parser.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/matcher/parser.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: scanner.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>scanner.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/matcher/scanner.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: matcher.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>matcher.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/matcher.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: message.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>message.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/message.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: monkey_patches.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>monkey_patches.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/monkey_patches.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-start_with? was introduced in 1.8.7, we need to support 1.8.5 and 1.8.6
-</p>
-
- </div>
-
- <div id="requires-list">
- <h3 class="section-bar">Required files</h3>
-
- <div class="name-list">
- enumerator
- </div>
- </div>
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
- <div id="constants-list">
- <h3 class="section-bar">Constants</h3>
-
- <div class="name-list">
- <table summary="Constants">
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">RbConfig</td>
- <td>=</td>
- <td class="context-item-value">::Config</td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: optionparser.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>optionparser.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/optionparser.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: pluginmanager.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>pluginmanager.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/pluginmanager.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: agent_definition.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>agent_definition.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/pluginpackager/agent_definition.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: standard_definition.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>standard_definition.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/pluginpackager/standard_definition.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: pluginpackager.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>pluginpackager.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/pluginpackager.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: base.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>base.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/registration/base.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: registration.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>registration.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/registration.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: actionrunner.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>actionrunner.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/rpc/actionrunner.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: agent.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>agent.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/rpc/agent.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: audit.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>audit.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/rpc/audit.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: client.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>client.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/rpc/client.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: helpers.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>helpers.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/rpc/helpers.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: progress.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>progress.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/rpc/progress.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: reply.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>reply.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/rpc/reply.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: request.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>request.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/rpc/request.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: result.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>result.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/rpc/result.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: stats.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>stats.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/rpc/stats.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: rpc.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>rpc.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/rpc.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
- <div id="requires-list">
- <h3 class="section-bar">Required files</h3>
-
- <div class="name-list">
- pp
- </div>
- </div>
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: runner.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>runner.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/runner.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: runnerstats.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>runnerstats.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/runnerstats.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: base.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>base.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/security/base.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: security.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>security.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/security.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: shell.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>shell.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/shell.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: ssl.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>ssl.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/ssl.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
- <div id="requires-list">
- <h3 class="section-bar">Required files</h3>
-
- <div class="name-list">
- openssl
- base64
- digest/sha1
- </div>
- </div>
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: translatable.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>translatable.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/translatable.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: unix_daemon.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>unix_daemon.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/unix_daemon.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: util.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>util.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/util.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
- <div id="requires-list">
- <h3 class="section-bar">Required files</h3>
-
- <div class="name-list">
- win32/dir
- </div>
- </div>
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: validator.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>validator.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/validator.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: windows_daemon.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>windows_daemon.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective/windows_daemon.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
- <div id="requires-list">
- <h3 class="section-bar">Required files</h3>
-
- <div class="name-list">
- win32/daemon
- </div>
- </div>
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>File: mcollective.rb</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="fileHeader">
- <h1>mcollective.rb</h1>
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Path:</strong></td>
- <td>lib/mcollective.rb
- </td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>Last Update:</strong></td>
- <td>Fri Nov 08 12:57:19 +0000 2013</td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
- <div id="requires-list">
- <h3 class="section-bar">Required files</h3>
-
- <div class="name-list">
- rubygems
- stomp
- timeout
- digest/md5
- optparse
- singleton
- socket
- erb
- shellwords
- stringio
- rbconfig
- tempfile
- tmpdir
- mcollective/exception
- mcollective/monkey_patches
- mcollective/translatable
- mcollective/cache
- </div>
- </div>
-
- </div>
-
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<!--
-
- Classes
-
- -->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Classes</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <link rel="stylesheet" href="rdoc-style.css" type="text/css" />
- <base target="docwin" />
-</head>
-<body>
-<div id="index">
- <h1 class="section-bar">Classes</h1>
- <div id="index-entries">
- <a href="classes/Array.html">Array</a><br />
- <a href="classes/Dir.html">Dir</a><br />
- <a href="classes/MCollective.html">MCollective</a><br />
- <a href="classes/MCollective/Agent.html">MCollective::Agent</a><br />
- <a href="classes/MCollective/Agents.html">MCollective::Agents</a><br />
- <a href="classes/MCollective/Aggregate.html">MCollective::Aggregate</a><br />
- <a href="classes/MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a><br />
- <a href="classes/MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a><br />
- <a href="classes/MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a><br />
- <a href="classes/MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a><br />
- <a href="classes/MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a><br />
- <a href="classes/MCollective/Application.html">MCollective::Application</a><br />
- <a href="classes/MCollective/Applications.html">MCollective::Applications</a><br />
- <a href="classes/MCollective/Cache.html">MCollective::Cache</a><br />
- <a href="classes/MCollective/Client.html">MCollective::Client</a><br />
- <a href="classes/MCollective/CodedError.html">MCollective::CodedError</a><br />
- <a href="classes/MCollective/Config.html">MCollective::Config</a><br />
- <a href="classes/MCollective/Connector.html">MCollective::Connector</a><br />
- <a href="classes/MCollective/Connector/Base.html">MCollective::Connector::Base</a><br />
- <a href="classes/MCollective/DDL.html">MCollective::DDL</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a><br />
- <a href="classes/MCollective/DDL/Base.html">MCollective::DDL::Base</a><br />
- <a href="classes/MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a><br />
- <a href="classes/MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a><br />
- <a href="classes/MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a><br />
- <a href="classes/MCollective/DDLValidationError.html">MCollective::DDLValidationError</a><br />
- <a href="classes/MCollective/Data.html">MCollective::Data</a><br />
- <a href="classes/MCollective/Data/Base.html">MCollective::Data::Base</a><br />
- <a href="classes/MCollective/Data/Result.html">MCollective::Data::Result</a><br />
- <a href="classes/MCollective/Discovery.html">MCollective::Discovery</a><br />
- <a href="classes/MCollective/Facts.html">MCollective::Facts</a><br />
- <a href="classes/MCollective/Facts/Base.html">MCollective::Facts::Base</a><br />
- <a href="classes/MCollective/Generators.html">MCollective::Generators</a><br />
- <a href="classes/MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a><br />
- <a href="classes/MCollective/Generators/Base.html">MCollective::Generators::Base</a><br />
- <a href="classes/MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a><br />
- <a href="classes/MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a><br />
- <a href="classes/MCollective/Log.html">MCollective::Log</a><br />
- <a href="classes/MCollective/Logger.html">MCollective::Logger</a><br />
- <a href="classes/MCollective/Logger/Base.html">MCollective::Logger::Base</a><br />
- <a href="classes/MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a><br />
- <a href="classes/MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a><br />
- <a href="classes/MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a><br />
- <a href="classes/MCollective/Matcher.html">MCollective::Matcher</a><br />
- <a href="classes/MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a><br />
- <a href="classes/MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a><br />
- <a href="classes/MCollective/Message.html">MCollective::Message</a><br />
- <a href="classes/MCollective/MissingRPCData.html">MCollective::MissingRPCData</a><br />
- <a href="classes/MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a><br />
- <a href="classes/MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a><br />
- <a href="classes/MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a><br />
- <a href="classes/MCollective/Optionparser.html">MCollective::Optionparser</a><br />
- <a href="classes/MCollective/PluginManager.html">MCollective::PluginManager</a><br />
- <a href="classes/MCollective/PluginPackager.html">MCollective::PluginPackager</a><br />
- <a href="classes/MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a><br />
- <a href="classes/MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a><br />
- <a href="classes/MCollective/RPC.html">MCollective::RPC</a><br />
- <a href="classes/MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a><br />
- <a href="classes/MCollective/RPC/Agent.html">MCollective::RPC::Agent</a><br />
- <a href="classes/MCollective/RPC/Audit.html">MCollective::RPC::Audit</a><br />
- <a href="classes/MCollective/RPC/Client.html">MCollective::RPC::Client</a><br />
- <a href="classes/MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a><br />
- <a href="classes/MCollective/RPC/Progress.html">MCollective::RPC::Progress</a><br />
- <a href="classes/MCollective/RPC/Reply.html">MCollective::RPC::Reply</a><br />
- <a href="classes/MCollective/RPC/Request.html">MCollective::RPC::Request</a><br />
- <a href="classes/MCollective/RPC/Result.html">MCollective::RPC::Result</a><br />
- <a href="classes/MCollective/RPC/Stats.html">MCollective::RPC::Stats</a><br />
- <a href="classes/MCollective/RPCAborted.html">MCollective::RPCAborted</a><br />
- <a href="classes/MCollective/RPCError.html">MCollective::RPCError</a><br />
- <a href="classes/MCollective/Registration.html">MCollective::Registration</a><br />
- <a href="classes/MCollective/Registration/Base.html">MCollective::Registration::Base</a><br />
- <a href="classes/MCollective/Runner.html">MCollective::Runner</a><br />
- <a href="classes/MCollective/RunnerStats.html">MCollective::RunnerStats</a><br />
- <a href="classes/MCollective/SSL.html">MCollective::SSL</a><br />
- <a href="classes/MCollective/Security.html">MCollective::Security</a><br />
- <a href="classes/MCollective/Security/Base.html">MCollective::Security::Base</a><br />
- <a href="classes/MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a><br />
- <a href="classes/MCollective/Shell.html">MCollective::Shell</a><br />
- <a href="classes/MCollective/Translatable.html">MCollective::Translatable</a><br />
- <a href="classes/MCollective/UnixDaemon.html">MCollective::UnixDaemon</a><br />
- <a href="classes/MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a><br />
- <a href="classes/MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a><br />
- <a href="classes/MCollective/Util.html">MCollective::Util</a><br />
- <a href="classes/MCollective/Validator.html">MCollective::Validator</a><br />
- <a href="classes/MCollective/ValidatorError.html">MCollective::ValidatorError</a><br />
- <a href="classes/MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a><br />
- <a href="classes/String.html">String</a><br />
- <a href="classes/Symbol.html">Symbol</a><br />
- </div>
-</div>
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<!--
-
- Files
-
- -->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Files</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <link rel="stylesheet" href="rdoc-style.css" type="text/css" />
- <base target="docwin" />
-</head>
-<body>
-<div id="index">
- <h1 class="section-bar">Files</h1>
- <div id="index-entries">
- <a href="files/install_rb.html">install.rb</a><br />
- <a href="files/lib/mcollective_rb.html">lib/mcollective.rb</a><br />
- <a href="files/lib/mcollective/agent_rb.html">lib/mcollective/agent.rb</a><br />
- <a href="files/lib/mcollective/agents_rb.html">lib/mcollective/agents.rb</a><br />
- <a href="files/lib/mcollective/aggregate_rb.html">lib/mcollective/aggregate.rb</a><br />
- <a href="files/lib/mcollective/aggregate/base_rb.html">lib/mcollective/aggregate/base.rb</a><br />
- <a href="files/lib/mcollective/aggregate/result_rb.html">lib/mcollective/aggregate/result.rb</a><br />
- <a href="files/lib/mcollective/aggregate/result/base_rb.html">lib/mcollective/aggregate/result/base.rb</a><br />
- <a href="files/lib/mcollective/aggregate/result/collection_result_rb.html">lib/mcollective/aggregate/result/collection_result.rb</a><br />
- <a href="files/lib/mcollective/aggregate/result/numeric_result_rb.html">lib/mcollective/aggregate/result/numeric_result.rb</a><br />
- <a href="files/lib/mcollective/application_rb.html">lib/mcollective/application.rb</a><br />
- <a href="files/lib/mcollective/applications_rb.html">lib/mcollective/applications.rb</a><br />
- <a href="files/lib/mcollective/cache_rb.html">lib/mcollective/cache.rb</a><br />
- <a href="files/lib/mcollective/client_rb.html">lib/mcollective/client.rb</a><br />
- <a href="files/lib/mcollective/config_rb.html">lib/mcollective/config.rb</a><br />
- <a href="files/lib/mcollective/connector_rb.html">lib/mcollective/connector.rb</a><br />
- <a href="files/lib/mcollective/connector/base_rb.html">lib/mcollective/connector/base.rb</a><br />
- <a href="files/lib/mcollective/data_rb.html">lib/mcollective/data.rb</a><br />
- <a href="files/lib/mcollective/data/base_rb.html">lib/mcollective/data/base.rb</a><br />
- <a href="files/lib/mcollective/data/result_rb.html">lib/mcollective/data/result.rb</a><br />
- <a href="files/lib/mcollective/ddl_rb.html">lib/mcollective/ddl.rb</a><br />
- <a href="files/lib/mcollective/ddl/agentddl_rb.html">lib/mcollective/ddl/agentddl.rb</a><br />
- <a href="files/lib/mcollective/ddl/base_rb.html">lib/mcollective/ddl/base.rb</a><br />
- <a href="files/lib/mcollective/ddl/dataddl_rb.html">lib/mcollective/ddl/dataddl.rb</a><br />
- <a href="files/lib/mcollective/ddl/discoveryddl_rb.html">lib/mcollective/ddl/discoveryddl.rb</a><br />
- <a href="files/lib/mcollective/ddl/validatorddl_rb.html">lib/mcollective/ddl/validatorddl.rb</a><br />
- <a href="files/lib/mcollective/discovery_rb.html">lib/mcollective/discovery.rb</a><br />
- <a href="files/lib/mcollective/exception_rb.html">lib/mcollective/exception.rb</a><br />
- <a href="files/lib/mcollective/facts_rb.html">lib/mcollective/facts.rb</a><br />
- <a href="files/lib/mcollective/facts/base_rb.html">lib/mcollective/facts/base.rb</a><br />
- <a href="files/lib/mcollective/generators_rb.html">lib/mcollective/generators.rb</a><br />
- <a href="files/lib/mcollective/generators/agent_generator_rb.html">lib/mcollective/generators/agent_generator.rb</a><br />
- <a href="files/lib/mcollective/generators/base_rb.html">lib/mcollective/generators/base.rb</a><br />
- <a href="files/lib/mcollective/generators/data_generator_rb.html">lib/mcollective/generators/data_generator.rb</a><br />
- <a href="files/lib/mcollective/log_rb.html">lib/mcollective/log.rb</a><br />
- <a href="files/lib/mcollective/logger_rb.html">lib/mcollective/logger.rb</a><br />
- <a href="files/lib/mcollective/logger/base_rb.html">lib/mcollective/logger/base.rb</a><br />
- <a href="files/lib/mcollective/logger/console_logger_rb.html">lib/mcollective/logger/console_logger.rb</a><br />
- <a href="files/lib/mcollective/logger/file_logger_rb.html">lib/mcollective/logger/file_logger.rb</a><br />
- <a href="files/lib/mcollective/logger/syslog_logger_rb.html">lib/mcollective/logger/syslog_logger.rb</a><br />
- <a href="files/lib/mcollective/matcher_rb.html">lib/mcollective/matcher.rb</a><br />
- <a href="files/lib/mcollective/matcher/parser_rb.html">lib/mcollective/matcher/parser.rb</a><br />
- <a href="files/lib/mcollective/matcher/scanner_rb.html">lib/mcollective/matcher/scanner.rb</a><br />
- <a href="files/lib/mcollective/message_rb.html">lib/mcollective/message.rb</a><br />
- <a href="files/lib/mcollective/monkey_patches_rb.html">lib/mcollective/monkey_patches.rb</a><br />
- <a href="files/lib/mcollective/optionparser_rb.html">lib/mcollective/optionparser.rb</a><br />
- <a href="files/lib/mcollective/pluginmanager_rb.html">lib/mcollective/pluginmanager.rb</a><br />
- <a href="files/lib/mcollective/pluginpackager_rb.html">lib/mcollective/pluginpackager.rb</a><br />
- <a href="files/lib/mcollective/pluginpackager/agent_definition_rb.html">lib/mcollective/pluginpackager/agent_definition.rb</a><br />
- <a href="files/lib/mcollective/pluginpackager/standard_definition_rb.html">lib/mcollective/pluginpackager/standard_definition.rb</a><br />
- <a href="files/lib/mcollective/registration_rb.html">lib/mcollective/registration.rb</a><br />
- <a href="files/lib/mcollective/registration/base_rb.html">lib/mcollective/registration/base.rb</a><br />
- <a href="files/lib/mcollective/rpc_rb.html">lib/mcollective/rpc.rb</a><br />
- <a href="files/lib/mcollective/rpc/actionrunner_rb.html">lib/mcollective/rpc/actionrunner.rb</a><br />
- <a href="files/lib/mcollective/rpc/agent_rb.html">lib/mcollective/rpc/agent.rb</a><br />
- <a href="files/lib/mcollective/rpc/audit_rb.html">lib/mcollective/rpc/audit.rb</a><br />
- <a href="files/lib/mcollective/rpc/client_rb.html">lib/mcollective/rpc/client.rb</a><br />
- <a href="files/lib/mcollective/rpc/helpers_rb.html">lib/mcollective/rpc/helpers.rb</a><br />
- <a href="files/lib/mcollective/rpc/progress_rb.html">lib/mcollective/rpc/progress.rb</a><br />
- <a href="files/lib/mcollective/rpc/reply_rb.html">lib/mcollective/rpc/reply.rb</a><br />
- <a href="files/lib/mcollective/rpc/request_rb.html">lib/mcollective/rpc/request.rb</a><br />
- <a href="files/lib/mcollective/rpc/result_rb.html">lib/mcollective/rpc/result.rb</a><br />
- <a href="files/lib/mcollective/rpc/stats_rb.html">lib/mcollective/rpc/stats.rb</a><br />
- <a href="files/lib/mcollective/runner_rb.html">lib/mcollective/runner.rb</a><br />
- <a href="files/lib/mcollective/runnerstats_rb.html">lib/mcollective/runnerstats.rb</a><br />
- <a href="files/lib/mcollective/security_rb.html">lib/mcollective/security.rb</a><br />
- <a href="files/lib/mcollective/security/base_rb.html">lib/mcollective/security/base.rb</a><br />
- <a href="files/lib/mcollective/shell_rb.html">lib/mcollective/shell.rb</a><br />
- <a href="files/lib/mcollective/ssl_rb.html">lib/mcollective/ssl.rb</a><br />
- <a href="files/lib/mcollective/translatable_rb.html">lib/mcollective/translatable.rb</a><br />
- <a href="files/lib/mcollective/unix_daemon_rb.html">lib/mcollective/unix_daemon.rb</a><br />
- <a href="files/lib/mcollective/util_rb.html">lib/mcollective/util.rb</a><br />
- <a href="files/lib/mcollective/validator_rb.html">lib/mcollective/validator.rb</a><br />
- <a href="files/lib/mcollective/windows_daemon_rb.html">lib/mcollective/windows_daemon.rb</a><br />
- </div>
-</div>
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<!--
-
- Methods
-
- -->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Methods</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <link rel="stylesheet" href="rdoc-style.css" type="text/css" />
- <base target="docwin" />
-</head>
-<body>
-<div id="index">
- <h1 class="section-bar">Methods</h1>
- <div id="index-entries">
- <a href="classes/MCollective/PluginManager.html#M000025"><< (MCollective::PluginManager)</a><br />
- <a href="classes/Symbol.html#M000014"><=> (Symbol)</a><br />
- <a href="classes/MCollective/Facts.html#M000018">[] (MCollective::Facts)</a><br />
- <a href="classes/MCollective/PluginManager.html#M000030">[] (MCollective::PluginManager)</a><br />
- <a href="classes/MCollective/PluginPackager.html#M000312">[] (MCollective::PluginPackager)</a><br />
- <a href="classes/MCollective/Applications.html#M000425">[] (MCollective::Applications)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000123">[] (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/RPC/Reply.html#M000077">[] (MCollective::RPC::Reply)</a><br />
- <a href="classes/MCollective/RPC/Result.html#M000054">[] (MCollective::RPC::Result)</a><br />
- <a href="classes/MCollective/Data/Result.html#M000233">[] (MCollective::Data::Result)</a><br />
- <a href="classes/MCollective/Application.html#M000347">[] (MCollective::Application)</a><br />
- <a href="classes/MCollective/Validator.html#M000217">[] (MCollective::Validator)</a><br />
- <a href="classes/MCollective/Data.html#M000225">[] (MCollective::Data)</a><br />
- <a href="classes/MCollective/RPC/Request.html#M000138">[] (MCollective::RPC::Request)</a><br />
- <a href="classes/MCollective/RPC/Result.html#M000055">[]= (MCollective::RPC::Result)</a><br />
- <a href="classes/MCollective/RPC/Reply.html#M000076">[]= (MCollective::RPC::Reply)</a><br />
- <a href="classes/MCollective/Data/Result.html#M000234">[]= (MCollective::Data::Result)</a><br />
- <a href="classes/MCollective/Application.html#M000346">[]= (MCollective::Application)</a><br />
- <a href="classes/MCollective/Util.html#M000307">absolute_path? (MCollective::Util)</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html#M000183">action (MCollective::DDL::AgentDDL)</a><br />
- <a href="classes/MCollective/Generators/AgentGenerator.html#M000252">action_help (MCollective::Generators::AgentGenerator)</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html#M000188">action_interface (MCollective::DDL::AgentDDL)</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html#M000189">actions (MCollective::DDL::AgentDDL)</a><br />
- <a href="classes/MCollective/RPC/Agent.html#M000084">actions (MCollective::RPC::Agent)</a><br />
- <a href="classes/MCollective/Data/Base.html#M000243">activate? (MCollective::Data::Base)</a><br />
- <a href="classes/MCollective/RPC/Agent.html#M000083">activate? (MCollective::RPC::Agent)</a><br />
- <a href="classes/MCollective/Agents.html#M000487">activate_agent? (MCollective::Agents)</a><br />
- <a href="classes/MCollective/Data/Base.html#M000242">activate_when (MCollective::Data::Base)</a><br />
- <a href="classes/MCollective/Optionparser.html#M000455">add_common_options (MCollective::Optionparser)</a><br />
- <a href="classes/MCollective/Optionparser.html#M000453">add_filter_options (MCollective::Optionparser)</a><br />
- <a href="classes/MCollective/Optionparser.html#M000454">add_required_options (MCollective::Optionparser)</a><br />
- <a href="classes/MCollective/RPC/Helpers.html#M000050">add_simplerpc_options (MCollective::RPC::Helpers)</a><br />
- <a href="classes/MCollective/SSL.html#M000386">aes_decrypt (MCollective::SSL)</a><br />
- <a href="classes/MCollective/SSL.html#M000385">aes_encrypt (MCollective::SSL)</a><br />
- <a href="classes/MCollective/PluginPackager/AgentDefinition.html#M000325">agent (MCollective::PluginPackager::AgentDefinition)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000098">agent_filter (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Agents.html#M000491">agentlist (MCollective::Agents)</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html#M000181">aggregate (MCollective::DDL::AgentDDL)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000112">aggregate_reply (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Util.html#M000303">align_text (MCollective::Util)</a><br />
- <a href="classes/MCollective/Application.html#M000362">application_cli_arguments (MCollective::Application)</a><br />
- <a href="classes/MCollective/Application.html#M000360">application_description (MCollective::Application)</a><br />
- <a href="classes/MCollective/Application.html#M000363">application_failure (MCollective::Application)</a><br />
- <a href="classes/MCollective/Application.html#M000359">application_options (MCollective::Application)</a><br />
- <a href="classes/MCollective/Application.html#M000345">application_options (MCollective::Application)</a><br />
- <a href="classes/MCollective/Application.html#M000357">application_parse_options (MCollective::Application)</a><br />
- <a href="classes/MCollective/Application.html#M000361">application_usage (MCollective::Application)</a><br />
- <a href="classes/MCollective/RPC/Audit.html#M000071">audit_request (MCollective::RPC::Audit)</a><br />
- <a href="classes/MCollective/Message.html#M000338">base64? (MCollective::Message)</a><br />
- <a href="classes/MCollective/SSL.html#M000392">base64_decode (MCollective::SSL)</a><br />
- <a href="classes/MCollective/SSL.html#M000391">base64_decode (MCollective::SSL)</a><br />
- <a href="classes/MCollective/Message.html#M000336">base64_decode! (MCollective::Message)</a><br />
- <a href="classes/MCollective/SSL.html#M000390">base64_encode (MCollective::SSL)</a><br />
- <a href="classes/MCollective/SSL.html#M000389">base64_encode (MCollective::SSL)</a><br />
- <a href="classes/MCollective/Message.html#M000337">base64_encode! (MCollective::Message)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000108">batch_size= (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000109">batch_sleep_time= (MCollective::RPC::Client)</a><br />
- <a href="files/install_rb.html#M000007">build_rdoc (install.rb)</a><br />
- <a href="classes/String.html#M000010">bytes (String)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000117">call_agent (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000116">call_agent_batched (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Aggregate.html#M000412">call_functions (MCollective::Aggregate)</a><br />
- <a href="classes/MCollective/Security/Base.html#M000267">callerid (MCollective::Security::Base)</a><br />
- <a href="classes/MCollective/RPC/ActionRunner.html#M000066">canrun? (MCollective::RPC::ActionRunner)</a><br />
- <a href="classes/MCollective/DDL/DiscoveryDDL.html#M000164">capabilities (MCollective::DDL::DiscoveryDDL)</a><br />
- <a href="classes/MCollective/Cache.html#M000273">check_cache! (MCollective::Cache)</a><br />
- <a href="classes/MCollective/Discovery.html#M000404">check_capabilities (MCollective::Discovery)</a><br />
- <a href="classes/MCollective/PluginPackager.html#M000314">check_dir_present (MCollective::PluginPackager)</a><br />
- <a href="classes/MCollective/Log.html#M000440">check_level (MCollective::Log)</a><br />
- <a href="files/install_rb.html#M000002">check_prereqs (install.rb)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000096">class_filter (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Agents.html#M000486">class_for_agent (MCollective::Agents)</a><br />
- <a href="classes/MCollective/PluginManager.html#M000029">clear (MCollective::PluginManager)</a><br />
- <a href="classes/MCollective/Agents.html#M000483">clear! (MCollective::Agents)</a><br />
- <a href="classes/MCollective/PluginPackager/AgentDefinition.html#M000326">client (MCollective::PluginPackager::AgentDefinition)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000126">client_stats= (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/Application.html#M000356">clioptions (MCollective::Application)</a><br />
- <a href="classes/MCollective/Client.html#M000457">collective (MCollective::Client)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000105">collective= (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Util.html#M000299">color (MCollective::Util)</a><br />
- <a href="classes/MCollective/Logger/Console_logger.html#M000210">color (MCollective::Logger::Console_logger)</a><br />
- <a href="classes/MCollective/Logger/Console_logger.html#M000211">colorize (MCollective::Logger::Console_logger)</a><br />
- <a href="classes/MCollective/Util.html#M000300">colorize (MCollective::Util)</a><br />
- <a href="classes/MCollective/PluginPackager.html#M000316">command_available? (MCollective::PluginPackager)</a><br />
- <a href="classes/MCollective/Util.html#M000305">command_in_path? (MCollective::Util)</a><br />
- <a href="classes/MCollective/PluginPackager/AgentDefinition.html#M000327">common (MCollective::PluginPackager::AgentDefinition)</a><br />
- <a href="classes/MCollective/PluginPackager/StandardDefinition.html#M000322">common (MCollective::PluginPackager::StandardDefinition)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000100">compound_filter (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Registration/Base.html#M000192">config (MCollective::Registration::Base)</a><br />
- <a href="classes/MCollective/Log.html#M000439">config_and_check_level (MCollective::Log)</a><br />
- <a href="classes/MCollective/Util.html#M000290">config_file_for_user (MCollective::Util)</a><br />
- <a href="classes/MCollective/Application.html#M000353">configuration (MCollective::Application)</a><br />
- <a href="classes/MCollective/Log.html#M000447">configure (MCollective::Log)</a><br />
- <a href="classes/MCollective/RPC.html#M000043">const_missing (MCollective::RPC)</a><br />
- <a href="classes/MCollective/Aggregate.html#M000411">contains_output? (MCollective::Aggregate)</a><br />
- <a href="classes/MCollective/Matcher.html#M000147">create_compound_callstack (MCollective::Matcher)</a><br />
- <a href="classes/MCollective/Generators/DataGenerator.html#M000254">create_ddl (MCollective::Generators::DataGenerator)</a><br />
- <a href="classes/MCollective/Generators/AgentGenerator.html#M000250">create_ddl (MCollective::Generators::AgentGenerator)</a><br />
- <a href="classes/MCollective/Matcher.html#M000143">create_function_hash (MCollective::Matcher)</a><br />
- <a href="classes/MCollective/Aggregate.html#M000410">create_functions (MCollective::Aggregate)</a><br />
- <a href="classes/MCollective/PluginManager.html#M000031">create_instance (MCollective::PluginManager)</a><br />
- <a href="classes/MCollective/Generators/Base.html#M000257">create_metadata_string (MCollective::Generators::Base)</a><br />
- <a href="classes/MCollective/Generators/AgentGenerator.html#M000251">create_plugin_content (MCollective::Generators::AgentGenerator)</a><br />
- <a href="classes/MCollective/Generators/DataGenerator.html#M000255">create_plugin_content (MCollective::Generators::DataGenerator)</a><br />
- <a href="classes/MCollective/Generators/Base.html#M000258">create_plugin_string (MCollective::Generators::Base)</a><br />
- <a href="classes/MCollective/Security/Base.html#M000263">create_reply (MCollective::Security::Base)</a><br />
- <a href="classes/MCollective/Message.html#M000344">create_reqid (MCollective::Message)</a><br />
- <a href="classes/MCollective/Security/Base.html#M000264">create_request (MCollective::Security::Base)</a><br />
- <a href="classes/MCollective/Client.html#M000460">createreq (MCollective::Client)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000091">custom_request (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Logger/Base.html#M000204">cycle_level (MCollective::Logger::Base)</a><br />
- <a href="classes/MCollective/Log.html#M000438">cycle_level (MCollective::Log)</a><br />
- <a href="classes/MCollective/UnixDaemon.html#M000423">daemonize (MCollective::UnixDaemon)</a><br />
- <a href="classes/MCollective/WindowsDaemon.html#M000373">daemonize_runner (MCollective::WindowsDaemon)</a><br />
- <a href="classes/MCollective/UnixDaemon.html#M000424">daemonize_runner (MCollective::UnixDaemon)</a><br />
- <a href="classes/MCollective/DDL/DataDDL.html#M000160">dataquery (MCollective::DDL::DataDDL)</a><br />
- <a href="classes/MCollective/DDL/DataDDL.html#M000162">dataquery_interface (MCollective::DDL::DataDDL)</a><br />
- <a href="classes/MCollective/Data.html#M000227">ddl (MCollective::Data)</a><br />
- <a href="classes/MCollective/Discovery.html#M000403">ddl (MCollective::Discovery)</a><br />
- <a href="classes/MCollective/Data.html#M000229">ddl_has_output? (MCollective::Data)</a><br />
- <a href="classes/MCollective/Data.html#M000230">ddl_transform_input (MCollective::Data)</a><br />
- <a href="classes/MCollective/Data/Base.html#M000241">ddl_validate (MCollective::Data::Base)</a><br />
- <a href="classes/MCollective/Data.html#M000228">ddl_validate (MCollective::Data)</a><br />
- <a href="classes/MCollective/Log.html#M000434">debug (MCollective::Log)</a><br />
- <a href="classes/MCollective/Message.html#M000341">decode! (MCollective::Message)</a><br />
- <a href="classes/MCollective/Security/Base.html#M000271">decodemsg (MCollective::Security::Base)</a><br />
- <a href="classes/MCollective/SSL.html#M000379">decrypt_with_private (MCollective::SSL)</a><br />
- <a href="classes/MCollective/SSL.html#M000380">decrypt_with_public (MCollective::SSL)</a><br />
- <a href="classes/MCollective/Util.html#M000291">default_options (MCollective::Util)</a><br />
- <a href="classes/MCollective/PluginManager.html#M000026">delete (MCollective::PluginManager)</a><br />
- <a href="classes/MCollective/Cache.html#M000275">delete! (MCollective::Cache)</a><br />
- <a href="classes/MCollective/Application.html#M000348">description (MCollective::Application)</a><br />
- <a href="classes/MCollective/Client.html#M000458">disconnect (MCollective::Client)</a><br />
- <a href="classes/MCollective/Application.html#M000366">disconnect (MCollective::Application)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000086">disconnect (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000103">discover (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Client.html#M000464">discover (MCollective::Client)</a><br />
- <a href="classes/MCollective/Discovery.html#M000408">discover (MCollective::Discovery)</a><br />
- <a href="classes/MCollective/RPC.html#M000039">discovered (MCollective::RPC)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000129">discovered_agents (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/Client.html#M000471">discovered_req (MCollective::Client)</a><br />
- <a href="classes/MCollective/DDL/DiscoveryDDL.html#M000165">discovery (MCollective::DDL::DiscoveryDDL)</a><br />
- <a href="classes/MCollective/Discovery.html#M000402">discovery_class (MCollective::Discovery)</a><br />
- <a href="classes/MCollective/DDL/DiscoveryDDL.html#M000163">discovery_interface (MCollective::DDL::DiscoveryDDL)</a><br />
- <a href="classes/MCollective/Discovery.html#M000401">discovery_method (MCollective::Discovery)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000094">discovery_method= (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000095">discovery_options= (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000092">discovery_timeout (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Discovery.html#M000407">discovery_timeout (MCollective::Discovery)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000093">discovery_timeout= (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Agents.html#M000490">dispatch (MCollective::Agents)</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html#M000182">display (MCollective::DDL::AgentDDL)</a><br />
- <a href="classes/MCollective/Client.html#M000472">display_stats (MCollective::Client)</a><br />
- <a href="files/install_rb.html#M000004">do_bins (install.rb)</a><br />
- <a href="files/install_rb.html#M000003">do_configs (install.rb)</a><br />
- <a href="files/install_rb.html#M000005">do_libs (install.rb)</a><br />
- <a href="classes/MCollective/RPC/Result.html#M000057">each (MCollective::RPC::Result)</a><br />
- <a href="classes/MCollective/Util.html#M000288">empty_filter (MCollective::Util)</a><br />
- <a href="classes/MCollective/Util.html#M000287">empty_filter? (MCollective::Util)</a><br />
- <a href="classes/MCollective/RPC.html#M000042">empty_filter? (MCollective::RPC)</a><br />
- <a href="classes/MCollective/Message.html#M000339">encode! (MCollective::Message)</a><br />
- <a href="classes/MCollective/Security/Base.html#M000270">encodereply (MCollective::Security::Base)</a><br />
- <a href="classes/MCollective/Security/Base.html#M000269">encoderequest (MCollective::Security::Base)</a><br />
- <a href="classes/MCollective/SSL.html#M000378">encrypt_with_private (MCollective::SSL)</a><br />
- <a href="classes/MCollective/SSL.html#M000377">encrypt_with_public (MCollective::SSL)</a><br />
- <a href="classes/MCollective/Log.html#M000436">error (MCollective::Log)</a><br />
- <a href="classes/MCollective/Matcher.html#M000146">eval_compound_fstatement (MCollective::Matcher)</a><br />
- <a href="classes/MCollective/Matcher.html#M000145">eval_compound_statement (MCollective::Matcher)</a><br />
- <a href="classes/MCollective/Application.html#M000350">exclude_argument_sections (MCollective::Application)</a><br />
- <a href="classes/MCollective/Matcher.html#M000144">execute_function (MCollective::Matcher)</a><br />
- <a href="classes/MCollective/PluginPackager.html#M000315">execute_verbosely (MCollective::PluginPackager)</a><br />
- <a href="classes/MCollective/Log.html#M000450">execution_stack (MCollective::Log)</a><br />
- <a href="classes/MCollective/Matcher/Parser.html#M000151">exit_with_paren_errors (MCollective::Matcher::Parser)</a><br />
- <a href="classes/MCollective/Matcher/Parser.html#M000150">exit_with_parse_errors (MCollective::Matcher::Parser)</a><br />
- <a href="classes/MCollective/Matcher/Parser.html#M000149">exit_with_token_errors (MCollective::Matcher::Parser)</a><br />
- <a href="classes/MCollective/Message.html#M000335">expected_msgid= (MCollective::Message)</a><br />
- <a href="classes/MCollective/RPC/Helpers.html#M000045">extract_hosts_from_array (MCollective::RPC::Helpers)</a><br />
- <a href="classes/MCollective/RPC/Helpers.html#M000044">extract_hosts_from_json (MCollective::RPC::Helpers)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000097">fact_filter (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/RPC/Reply.html#M000074">fail (MCollective::RPC::Reply)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000125">fail (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/RPC/Reply.html#M000075">fail! (MCollective::RPC::Reply)</a><br />
- <a href="classes/MCollective/Log.html#M000435">fatal (MCollective::Log)</a><br />
- <a href="classes/MCollective/RPC/Reply.html#M000078">fetch (MCollective::RPC::Reply)</a><br />
- <a href="classes/MCollective/RPC/Request.html#M000139">fetch (MCollective::RPC::Request)</a><br />
- <a href="classes/MCollective/RPC/Result.html#M000056">fetch (MCollective::RPC::Result)</a><br />
- <a href="classes/MCollective/PluginPackager.html#M000318">filter_dependencies (MCollective::PluginPackager)</a><br />
- <a href="classes/MCollective/Applications.html#M000429">filter_extra_options (MCollective::Applications)</a><br />
- <a href="classes/MCollective/RunnerStats.html#M000476">filtered (MCollective::RunnerStats)</a><br />
- <a href="classes/MCollective/PluginManager.html#M000032">find (MCollective::PluginManager)</a><br />
- <a href="classes/MCollective/PluginManager.html#M000033">find_and_load (MCollective::PluginManager)</a><br />
- <a href="classes/MCollective/Discovery.html#M000398">find_known_methods (MCollective::Discovery)</a><br />
- <a href="classes/MCollective/Agents.html#M000488">findagentfile (MCollective::Agents)</a><br />
- <a href="classes/MCollective/DDL/Base.html#M000171">findddlfile (MCollective::DDL::Base)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000130">finish_request (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000114">fire_and_forget_request (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Discovery.html#M000400">force_direct_mode? (MCollective::Discovery)</a><br />
- <a href="classes/MCollective/Discovery.html#M000405">force_discovery_method_by_filter (MCollective::Discovery)</a><br />
- <a href="classes/MCollective/Facts/Base.html#M000024">force_reload? (MCollective::Facts::Base)</a><br />
- <a href="classes/MCollective/Log.html#M000449">from (MCollective::Log)</a><br />
- <a href="classes/MCollective/Facts/Base.html#M000021">get_fact (MCollective::Facts::Base)</a><br />
- <a href="classes/MCollective/Facts.html#M000017">get_fact (MCollective::Facts)</a><br />
- <a href="classes/MCollective/Util.html#M000284">get_fact (MCollective::Util)</a><br />
- <a href="classes/MCollective/Facts/Base.html#M000022">get_facts (MCollective::Facts::Base)</a><br />
- <a href="classes/MCollective/PluginPackager.html#M000313">get_metadata (MCollective::PluginPackager)</a><br />
- <a href="classes/MCollective/Matcher/Scanner.html#M000154">get_token (MCollective::Matcher::Scanner)</a><br />
- <a href="files/install_rb.html#M000001">glob (install.rb)</a><br />
- <a href="classes/MCollective/PluginManager.html#M000035">grep (MCollective::PluginManager)</a><br />
- <a href="classes/MCollective/Application.html#M000369">halt (MCollective::Application)</a><br />
- <a href="classes/MCollective/Application.html#M000368">halt_code (MCollective::Application)</a><br />
- <a href="classes/MCollective/RPC/Agent.html#M000082">handlemsg (MCollective::RPC::Agent)</a><br />
- <a href="classes/MCollective/Util.html#M000281">has_agent? (MCollective::Util)</a><br />
- <a href="classes/MCollective/Cache.html#M000274">has_cache? (MCollective::Cache)</a><br />
- <a href="classes/MCollective/Util.html#M000283">has_cf_class? (MCollective::Util)</a><br />
- <a href="classes/MCollective/Facts.html#M000016">has_fact? (MCollective::Facts)</a><br />
- <a href="classes/MCollective/Facts/Base.html#M000023">has_fact? (MCollective::Facts::Base)</a><br />
- <a href="classes/MCollective/Util.html#M000285">has_fact? (MCollective::Util)</a><br />
- <a href="classes/MCollective/Util.html#M000286">has_identity? (MCollective::Util)</a><br />
- <a href="classes/MCollective/Discovery.html#M000399">has_method? (MCollective::Discovery)</a><br />
- <a href="classes/MCollective/Validator.html#M000219">has_validator? (MCollective::Validator)</a><br />
- <a href="classes/MCollective/DDL/Base.html#M000167">help (MCollective::DDL::Base)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000087">help (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Application.html#M000364">help (MCollective::Application)</a><br />
- <a href="classes/MCollective/PluginPackager/StandardDefinition.html#M000320">identify_packages (MCollective::PluginPackager::StandardDefinition)</a><br />
- <a href="classes/MCollective/PluginPackager/AgentDefinition.html#M000324">identify_packages (MCollective::PluginPackager::AgentDefinition)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000099">identity_filter (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000115">identity_filter_discovery_optimization (MCollective::RPC::Client)</a><br />
- <a href="classes/Array.html#M000013">in_groups_of (Array)</a><br />
- <a href="classes/MCollective/PluginManager.html#M000027">include? (MCollective::PluginManager)</a><br />
- <a href="classes/MCollective/Agents.html#M000489">include? (MCollective::Agents)</a><br />
- <a href="classes/MCollective/RPC/Request.html#M000136">include? (MCollective::RPC::Request)</a><br />
- <a href="classes/MCollective/Data/Result.html#M000232">include? (MCollective::Data::Result)</a><br />
- <a href="classes/MCollective/Log.html#M000432">info (MCollective::Log)</a><br />
- <a href="classes/MCollective/Connector/Base.html#M000328">inherited (MCollective::Connector::Base)</a><br />
- <a href="classes/MCollective/RPC/Audit.html#M000070">inherited (MCollective::RPC::Audit)</a><br />
- <a href="classes/MCollective/Registration/Base.html#M000190">inherited (MCollective::Registration::Base)</a><br />
- <a href="classes/MCollective/Data/Base.html#M000237">inherited (MCollective::Data::Base)</a><br />
- <a href="classes/MCollective/Facts/Base.html#M000020">inherited (MCollective::Facts::Base)</a><br />
- <a href="classes/MCollective/Security/Base.html#M000260">inherited (MCollective::Security::Base)</a><br />
- <a href="classes/MCollective/RPC/Reply.html#M000073">initialize_data (MCollective::RPC::Reply)</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html#M000179">input (MCollective::DDL::AgentDDL)</a><br />
- <a href="classes/MCollective/DDL/DataDDL.html#M000161">input (MCollective::DDL::DataDDL)</a><br />
- <a href="classes/MCollective/DDL/Base.html#M000174">input (MCollective::DDL::Base)</a><br />
- <a href="files/install_rb.html#M000008">install_binfile (install.rb)</a><br />
- <a href="classes/MCollective/Log.html#M000437">instance (MCollective::Log)</a><br />
- <a href="classes/MCollective/Registration/Base.html#M000195">interval (MCollective::Registration::Base)</a><br />
- <a href="classes/MCollective/Application.html#M000352">intialize_application_options (MCollective::Application)</a><br />
- <a href="classes/MCollective/Cache.html#M000280">invalidate! (MCollective::Cache)</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html#M000185">is_function? (MCollective::DDL::AgentDDL)</a><br />
- <a href="classes/MCollective/Data/Result.html#M000235">keys (MCollective::Data::Result)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000107">limit_method= (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000106">limit_targets= (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Applications.html#M000428">list (MCollective::Applications)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000111">load_aggregate_functions (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/DDL.html#M000156">load_and_cache (MCollective::DDL)</a><br />
- <a href="classes/MCollective/Applications.html#M000427">load_application (MCollective::Applications)</a><br />
- <a href="classes/MCollective/Applications.html#M000430">load_config (MCollective::Applications)</a><br />
- <a href="classes/MCollective/Data.html#M000223">load_data_sources (MCollective::Data)</a><br />
- <a href="classes/MCollective/RPC/Agent.html#M000081">load_ddl (MCollective::RPC::Agent)</a><br />
- <a href="classes/MCollective/Aggregate.html#M000414">load_function (MCollective::Aggregate)</a><br />
- <a href="classes/MCollective/RPC/ActionRunner.html#M000063">load_json_results (MCollective::RPC::ActionRunner)</a><br />
- <a href="classes/MCollective/PluginPackager.html#M000311">load_packagers (MCollective::PluginPackager)</a><br />
- <a href="classes/MCollective/RPC/ActionRunner.html#M000062">load_results (MCollective::RPC::ActionRunner)</a><br />
- <a href="classes/MCollective/Validator.html#M000216">load_validators (MCollective::Validator)</a><br />
- <a href="classes/MCollective/Validator.html#M000221">load_validators? (MCollective::Validator)</a><br />
- <a href="classes/MCollective/Agents.html#M000485">loadagent (MCollective::Agents)</a><br />
- <a href="classes/MCollective/Agents.html#M000484">loadagents (MCollective::Agents)</a><br />
- <a href="classes/MCollective/PluginManager.html#M000034">loadclass (MCollective::PluginManager)</a><br />
- <a href="classes/MCollective/Util.html#M000295">loadclass (MCollective::Util)</a><br />
- <a href="classes/MCollective/Config.html#M000493">loadconfig (MCollective::Config)</a><br />
- <a href="classes/MCollective/DDL/Base.html#M000170">loadddlfile (MCollective::DDL::Base)</a><br />
- <a href="classes/MCollective/Logger/Console_logger.html#M000209">log (MCollective::Logger::Console_logger)</a><br />
- <a href="classes/MCollective/Logger/File_logger.html#M000215">log (MCollective::Logger::File_logger)</a><br />
- <a href="classes/MCollective/Log.html#M000445">log (MCollective::Log)</a><br />
- <a href="classes/MCollective/Logger/Syslog_logger.html#M000201">log (MCollective::Logger::Syslog_logger)</a><br />
- <a href="classes/MCollective/CodedError.html#M000331">log (MCollective::CodedError)</a><br />
- <a href="classes/MCollective/Translatable.html#M000246">log_code (MCollective::Translatable)</a><br />
- <a href="classes/MCollective/Log.html#M000443">logexception (MCollective::Log)</a><br />
- <a href="classes/MCollective/Translatable.html#M000248">logexception (MCollective::Translatable)</a><br />
- <a href="classes/MCollective/Log.html#M000431">logger (MCollective::Log)</a><br />
- <a href="classes/MCollective/Log.html#M000444">logmsg (MCollective::Log)</a><br />
- <a href="classes/MCollective/Data/Base.html#M000239">lookup (MCollective::Data::Base)</a><br />
- <a href="classes/MCollective/Application.html#M000367">main (MCollective::Application)</a><br />
- <a href="classes/MCollective/Util.html#M000292">make_subscriptions (MCollective::Util)</a><br />
- <a href="classes/MCollective/Util.html#M000302">mcollective_version (MCollective::Util)</a><br />
- <a href="classes/MCollective/SSL.html#M000394">md5 (MCollective::SSL)</a><br />
- <a href="classes/MCollective/SSL.html#M000393">md5 (MCollective::SSL)</a><br />
- <a href="classes/MCollective/Log.html#M000442">message_for (MCollective::Log)</a><br />
- <a href="classes/MCollective/DDL/Base.html#M000177">metadata (MCollective::DDL::Base)</a><br />
- <a href="classes/MCollective/Data/Result.html#M000236">method_missing (MCollective::Data::Result)</a><br />
- <a href="classes/MCollective/Data.html#M000226">method_missing (MCollective::Data)</a><br />
- <a href="classes/MCollective/Validator.html#M000218">method_missing (MCollective::Validator)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000090">method_missing (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html#M000184">method_missing (MCollective::DDL::AgentDDL)</a><br />
- <a href="classes/Dir.html#M000011">mktmpdir (Dir)</a><br />
- <a href="classes/MCollective/Registration/Base.html#M000193">msg_filter (MCollective::Registration::Base)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000120">new (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/RunnerStats.html#M000473">new (MCollective::RunnerStats)</a><br />
- <a href="classes/MCollective/SSL.html#M000376">new (MCollective::SSL)</a><br />
- <a href="classes/MCollective/RPC/Request.html#M000135">new (MCollective::RPC::Request)</a><br />
- <a href="classes/MCollective/Matcher/Parser.html#M000148">new (MCollective::Matcher::Parser)</a><br />
- <a href="classes/MCollective/Agents.html#M000482">new (MCollective::Agents)</a><br />
- <a href="classes/MCollective/Data/Result.html#M000231">new (MCollective::Data::Result)</a><br />
- <a href="classes/MCollective/Shell.html#M000371">new (MCollective::Shell)</a><br />
- <a href="classes/MCollective/Data/Base.html#M000238">new (MCollective::Data::Base)</a><br />
- <a href="classes/MCollective/Aggregate.html#M000409">new (MCollective::Aggregate)</a><br />
- <a href="classes/MCollective/Matcher/Scanner.html#M000153">new (MCollective::Matcher::Scanner)</a><br />
- <a href="classes/MCollective/Facts/Base.html#M000019">new (MCollective::Facts::Base)</a><br />
- <a href="classes/MCollective/DDL.html#M000155">new (MCollective::DDL)</a><br />
- <a href="classes/MCollective/Aggregate/Base.html#M000420">new (MCollective::Aggregate::Base)</a><br />
- <a href="classes/MCollective/Config.html#M000492">new (MCollective::Config)</a><br />
- <a href="classes/MCollective/DDL/Base.html#M000166">new (MCollective::DDL::Base)</a><br />
- <a href="classes/MCollective/Client.html#M000456">new (MCollective::Client)</a><br />
- <a href="classes/MCollective/Aggregate/Result/Base.html#M000416">new (MCollective::Aggregate::Result::Base)</a><br />
- <a href="classes/MCollective/RPC/ActionRunner.html#M000059">new (MCollective::RPC::ActionRunner)</a><br />
- <a href="classes/MCollective/Generators/AgentGenerator.html#M000249">new (MCollective::Generators::AgentGenerator)</a><br />
- <a href="classes/MCollective/RPC/Reply.html#M000072">new (MCollective::RPC::Reply)</a><br />
- <a href="classes/MCollective/Optionparser.html#M000451">new (MCollective::Optionparser)</a><br />
- <a href="classes/MCollective/PluginPackager/StandardDefinition.html#M000319">new (MCollective::PluginPackager::StandardDefinition)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000085">new (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/RPC/Agent.html#M000080">new (MCollective::RPC::Agent)</a><br />
- <a href="classes/MCollective/RPC/Progress.html#M000051">new (MCollective::RPC::Progress)</a><br />
- <a href="classes/MCollective/Generators/DataGenerator.html#M000253">new (MCollective::Generators::DataGenerator)</a><br />
- <a href="classes/MCollective/Logger/Base.html#M000202">new (MCollective::Logger::Base)</a><br />
- <a href="classes/MCollective/Generators/Base.html#M000256">new (MCollective::Generators::Base)</a><br />
- <a href="classes/MCollective/RPC/Result.html#M000053">new (MCollective::RPC::Result)</a><br />
- <a href="classes/MCollective/Discovery.html#M000397">new (MCollective::Discovery)</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html#M000178">new (MCollective::DDL::AgentDDL)</a><br />
- <a href="classes/MCollective/CodedError.html#M000329">new (MCollective::CodedError)</a><br />
- <a href="classes/MCollective/Runner.html#M000496">new (MCollective::Runner)</a><br />
- <a href="classes/MCollective/Security/Base.html#M000261">new (MCollective::Security::Base)</a><br />
- <a href="classes/MCollective/Message.html#M000332">new (MCollective::Message)</a><br />
- <a href="classes/MCollective/PluginPackager/AgentDefinition.html#M000323">new (MCollective::PluginPackager::AgentDefinition)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000088">new_request (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000134">no_response_report (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000131">node_responded (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000124">ok (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/RPC/Helpers.html#M000049">old_rpcresults (MCollective::RPC::Helpers)</a><br />
- <a href="classes/MCollective/Application.html#M000351">option (MCollective::Application)</a><br />
- <a href="classes/MCollective/Application.html#M000354">options (MCollective::Application)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000104">options (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/DDL/Base.html#M000175">output (MCollective::DDL::Base)</a><br />
- <a href="classes/MCollective/Optionparser.html#M000452">parse (MCollective::Optionparser)</a><br />
- <a href="classes/MCollective/Matcher/Parser.html#M000152">parse (MCollective::Matcher::Parser)</a><br />
- <a href="classes/MCollective/Util.html#M000296">parse_fact_string (MCollective::Util)</a><br />
- <a href="classes/MCollective/RunnerStats.html#M000475">passed (MCollective::RunnerStats)</a><br />
- <a href="classes/MCollective/RPC/ActionRunner.html#M000069">path_to_command (MCollective::RPC::ActionRunner)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000110">pick_nodes_from_discovered (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/PluginPackager/StandardDefinition.html#M000321">plugin (MCollective::PluginPackager::StandardDefinition)</a><br />
- <a href="classes/MCollective/PluginManager.html#M000028">pluginlist (MCollective::PluginManager)</a><br />
- <a href="classes/MCollective/Data.html#M000224">pluginname (MCollective::Data)</a><br />
- <a href="files/install_rb.html#M000006">prepare_installation (install.rb)</a><br />
- <a href="classes/MCollective/RPC.html#M000041">printrpc (MCollective::RPC)</a><br />
- <a href="classes/MCollective/RPC.html#M000040">printrpcstats (MCollective::RPC)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000119">process_results_with_block (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000118">process_results_without_block (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Message.html#M000343">publish (MCollective::Message)</a><br />
- <a href="classes/MCollective/Registration/Base.html#M000196">publish (MCollective::Registration::Base)</a><br />
- <a href="classes/MCollective/Data/Base.html#M000240">query (MCollective::Data::Base)</a><br />
- <a href="classes/MCollective/Translatable.html#M000247">raise_code (MCollective::Translatable)</a><br />
- <a href="classes/MCollective/Cache.html#M000277">read (MCollective::Cache)</a><br />
- <a href="classes/MCollective/SSL.html#M000396">read_key (MCollective::SSL)</a><br />
- <a href="classes/MCollective/Config.html#M000495">read_plugin_config_dir (MCollective::Config)</a><br />
- <a href="classes/MCollective/Client.html#M000463">receive (MCollective::Client)</a><br />
- <a href="classes/MCollective/RunnerStats.html#M000479">received (MCollective::RunnerStats)</a><br />
- <a href="classes/MCollective/Message.html#M000334">reply_to= (MCollective::Message)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000133">report (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/Client.html#M000465">req (MCollective::Client)</a><br />
- <a href="classes/MCollective/DDL/Base.html#M000176">requires (MCollective::DDL::Base)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000101">reset (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000121">reset (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000102">reset_filter (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Aggregate/Base.html#M000422">result_class (MCollective::Aggregate::Base)</a><br />
- <a href="classes/MCollective/Aggregate/Result/Base.html#M000418">result_type (MCollective::Aggregate::Result::Base)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000113">rpc_result_from_reply (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/Application.html#M000370">rpcclient (MCollective::Application)</a><br />
- <a href="classes/MCollective/RPC.html#M000037">rpcclient (MCollective::RPC)</a><br />
- <a href="classes/MCollective/RPC.html#M000036">rpcoptions (MCollective::RPC)</a><br />
- <a href="classes/MCollective/RPC/Helpers.html#M000046">rpcresults (MCollective::RPC::Helpers)</a><br />
- <a href="classes/MCollective/SSL.html#M000382">rsa_decrypt_with_private (MCollective::SSL)</a><br />
- <a href="classes/MCollective/SSL.html#M000384">rsa_decrypt_with_public (MCollective::SSL)</a><br />
- <a href="classes/MCollective/SSL.html#M000383">rsa_encrypt_with_private (MCollective::SSL)</a><br />
- <a href="classes/MCollective/SSL.html#M000381">rsa_encrypt_with_public (MCollective::SSL)</a><br />
- <a href="classes/MCollective/Util.html#M000301">ruby_version (MCollective::Util)</a><br />
- <a href="classes/MCollective/Applications.html#M000426">run (MCollective::Applications)</a><br />
- <a href="classes/MCollective/Application.html#M000365">run (MCollective::Application)</a><br />
- <a href="classes/MCollective/Registration/Base.html#M000191">run (MCollective::Registration::Base)</a><br />
- <a href="classes/MCollective/RPC/ActionRunner.html#M000060">run (MCollective::RPC::ActionRunner)</a><br />
- <a href="classes/MCollective/Runner.html#M000497">run (MCollective::Runner)</a><br />
- <a href="classes/MCollective/Shell.html#M000372">runcommand (MCollective::Shell)</a><br />
- <a href="classes/MCollective/PluginPackager.html#M000317">safe_system (MCollective::PluginPackager)</a><br />
- <a href="classes/MCollective/RPC/ActionRunner.html#M000065">save_json_request (MCollective::RPC::ActionRunner)</a><br />
- <a href="classes/MCollective/RPC/ActionRunner.html#M000064">saverequest (MCollective::RPC::ActionRunner)</a><br />
- <a href="classes/MCollective/Client.html#M000459">sendreq (MCollective::Client)</a><br />
- <a href="classes/MCollective/RunnerStats.html#M000480">sent (MCollective::RunnerStats)</a><br />
- <a href="classes/MCollective/WindowsDaemon.html#M000374">service_main (MCollective::WindowsDaemon)</a><br />
- <a href="classes/MCollective/WindowsDaemon.html#M000375">service_stop (MCollective::WindowsDaemon)</a><br />
- <a href="classes/MCollective/CodedError.html#M000330">set_backtrace (MCollective::CodedError)</a><br />
- <a href="classes/MCollective/Config.html#M000494">set_config_defaults (MCollective::Config)</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html#M000186">set_default_input_arguments (MCollective::DDL::AgentDDL)</a><br />
- <a href="classes/MCollective/Logger/Base.html#M000205">set_level (MCollective::Logger::Base)</a><br />
- <a href="classes/MCollective/Log.html#M000446">set_logger (MCollective::Log)</a><br />
- <a href="classes/MCollective/Logger/File_logger.html#M000213">set_logging_level (MCollective::Logger::File_logger)</a><br />
- <a href="classes/MCollective/Logger/Console_logger.html#M000207">set_logging_level (MCollective::Logger::Console_logger)</a><br />
- <a href="classes/MCollective/Logger/Syslog_logger.html#M000199">set_logging_level (MCollective::Logger::Syslog_logger)</a><br />
- <a href="classes/MCollective/Cache.html#M000272">setup (MCollective::Cache)</a><br />
- <a href="classes/MCollective/Util.html#M000282">setup_windows_sleeper (MCollective::Util)</a><br />
- <a href="classes/MCollective/RPC/ActionRunner.html#M000061">shell (MCollective::RPC::ActionRunner)</a><br />
- <a href="classes/MCollective/Util.html#M000297">shellescape (MCollective::Util)</a><br />
- <a href="classes/MCollective/Logger/Base.html#M000203">should_log? (MCollective::Logger::Base)</a><br />
- <a href="classes/MCollective/Security/Base.html#M000265">should_process_msg? (MCollective::Security::Base)</a><br />
- <a href="classes/MCollective/RPC/Request.html#M000137">should_respond? (MCollective::RPC::Request)</a><br />
- <a href="classes/MCollective/SSL.html#M000387">sign (MCollective::SSL)</a><br />
- <a href="classes/MCollective/Logger/Syslog_logger.html#M000197">start (MCollective::Logger::Syslog_logger)</a><br />
- <a href="classes/MCollective/Logger/Console_logger.html#M000206">start (MCollective::Logger::Console_logger)</a><br />
- <a href="classes/MCollective/Logger/File_logger.html#M000212">start (MCollective::Logger::File_logger)</a><br />
- <a href="classes/MCollective/Client.html#M000468">start_publisher (MCollective::Client)</a><br />
- <a href="classes/MCollective/Client.html#M000469">start_receiver (MCollective::Client)</a><br />
- <a href="classes/String.html#M000009">start_with? (String)</a><br />
- <a href="classes/MCollective/Data/Base.html#M000244">startup_hook (MCollective::Data::Base)</a><br />
- <a href="classes/MCollective/RPC.html#M000038">stats (MCollective::RPC)</a><br />
- <a href="classes/MCollective/Util.html#M000308">str_to_bool (MCollective::Util)</a><br />
- <a href="classes/MCollective/DDL.html#M000157">string_to_boolean (MCollective::DDL)</a><br />
- <a href="classes/MCollective/DDL.html#M000158">string_to_number (MCollective::DDL)</a><br />
- <a href="classes/MCollective/Util.html#M000293">subscribe (MCollective::Util)</a><br />
- <a href="classes/MCollective/Client.html#M000461">subscribe (MCollective::Client)</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html#M000180">summarize (MCollective::DDL::AgentDDL)</a><br />
- <a href="classes/MCollective/Aggregate/Base.html#M000421">summarize (MCollective::Aggregate::Base)</a><br />
- <a href="classes/MCollective/Aggregate.html#M000413">summarize (MCollective::Aggregate)</a><br />
- <a href="classes/MCollective/Cache.html#M000279">synchronize (MCollective::Cache)</a><br />
- <a href="classes/MCollective/Logger/Syslog_logger.html#M000198">syslog_facility (MCollective::Logger::Syslog_logger)</a><br />
- <a href="classes/MCollective/Translatable.html#M000245">t (MCollective::Translatable)</a><br />
- <a href="classes/MCollective/Util.html#M000309">t (MCollective::Util)</a><br />
- <a href="classes/MCollective/Registration/Base.html#M000194">target_collective (MCollective::Registration::Base)</a><br />
- <a href="classes/MCollective/RPC/ActionRunner.html#M000068">tempfile (MCollective::RPC::ActionRunner)</a><br />
- <a href="classes/MCollective/DDL/Base.html#M000169">template_for_plugintype (MCollective::DDL::Base)</a><br />
- <a href="classes/MCollective/Util.html#M000310">templatepath (MCollective::Util)</a><br />
- <a href="classes/MCollective/Util.html#M000304">terminal_dimensions (MCollective::Util)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000132">text_for_aggregates (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/RPC/Helpers.html#M000048">text_for_flattened_result (MCollective::RPC::Helpers)</a><br />
- <a href="classes/MCollective/RPC/Helpers.html#M000047">text_for_result (MCollective::RPC::Helpers)</a><br />
- <a href="classes/MCollective/Client.html#M000467">threaded_req (MCollective::Client)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000128">time_block_execution (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000127">time_discovery (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/Discovery.html#M000406">timeout_for_compound_filter (MCollective::Discovery)</a><br />
- <a href="classes/Dir.html#M000012">tmpdir (Dir)</a><br />
- <a href="classes/MCollective/RPC/Request.html#M000140">to_hash (MCollective::RPC::Request)</a><br />
- <a href="classes/MCollective/RunnerStats.html#M000481">to_hash (MCollective::RunnerStats)</a><br />
- <a href="classes/MCollective/RPC/Reply.html#M000079">to_hash (MCollective::RPC::Reply)</a><br />
- <a href="classes/MCollective/RPC/Stats.html#M000122">to_hash (MCollective::RPC::Stats)</a><br />
- <a href="classes/MCollective/RPC/Result.html#M000058">to_json (MCollective::RPC::Result)</a><br />
- <a href="classes/MCollective/RPC/Request.html#M000142">to_json (MCollective::RPC::Request)</a><br />
- <a href="classes/MCollective/Aggregate/Result/NumericResult.html#M000419">to_s (MCollective::Aggregate::Result::NumericResult)</a><br />
- <a href="classes/MCollective/RPC/ActionRunner.html#M000067">to_s (MCollective::RPC::ActionRunner)</a><br />
- <a href="classes/MCollective/Aggregate/Result/CollectionResult.html#M000415">to_s (MCollective::Aggregate::Result::CollectionResult)</a><br />
- <a href="classes/MCollective/Aggregate/Result/Base.html#M000417">to_s (MCollective::Aggregate::Result::Base)</a><br />
- <a href="classes/MCollective/Cache.html#M000278">ttl (MCollective::Cache)</a><br />
- <a href="classes/MCollective/RunnerStats.html#M000474">ttlexpired (MCollective::RunnerStats)</a><br />
- <a href="classes/MCollective/RPC/Progress.html#M000052">twirl (MCollective::RPC::Progress)</a><br />
- <a href="classes/MCollective/Message.html#M000333">type= (MCollective::Message)</a><br />
- <a href="classes/MCollective/Log.html#M000448">unconfigure (MCollective::Log)</a><br />
- <a href="classes/MCollective/Util.html#M000294">unsubscribe (MCollective::Util)</a><br />
- <a href="classes/MCollective/Client.html#M000462">unsubscribe (MCollective::Client)</a><br />
- <a href="classes/MCollective/Client.html#M000466">unthreaded_req (MCollective::Client)</a><br />
- <a href="classes/MCollective/RunnerStats.html#M000478">unvalidated (MCollective::RunnerStats)</a><br />
- <a href="classes/MCollective/Client.html#M000470">update_stat (MCollective::Client)</a><br />
- <a href="classes/MCollective/DDL/Base.html#M000168">usage (MCollective::DDL::Base)</a><br />
- <a href="classes/MCollective/Application.html#M000349">usage (MCollective::Application)</a><br />
- <a href="classes/MCollective/SSL.html#M000395">uuid (MCollective::SSL)</a><br />
- <a href="classes/MCollective/Security/Base.html#M000266">valid_callerid? (MCollective::Security::Base)</a><br />
- <a href="classes/MCollective/Log.html#M000441">valid_level? (MCollective::Log)</a><br />
- <a href="classes/MCollective/Logger/Console_logger.html#M000208">valid_levels (MCollective::Logger::Console_logger)</a><br />
- <a href="classes/MCollective/Logger/Syslog_logger.html#M000200">valid_levels (MCollective::Logger::Syslog_logger)</a><br />
- <a href="classes/MCollective/Logger/File_logger.html#M000214">valid_levels (MCollective::Logger::File_logger)</a><br />
- <a href="classes/MCollective/Message.html#M000342">validate (MCollective::Message)</a><br />
- <a href="classes/MCollective/Validator.html#M000222">validate (MCollective::Validator)</a><br />
- <a href="classes/MCollective/RPC/Request.html#M000141">validate! (MCollective::RPC::Request)</a><br />
- <a href="classes/MCollective/Application.html#M000358">validate_cli_options (MCollective::Application)</a><br />
- <a href="classes/MCollective/Message.html#M000340">validate_compound_filter (MCollective::Message)</a><br />
- <a href="classes/MCollective/Security/Base.html#M000262">validate_filter? (MCollective::Security::Base)</a><br />
- <a href="classes/MCollective/DDL/Base.html#M000173">validate_input_argument (MCollective::DDL::Base)</a><br />
- <a href="classes/MCollective/Application.html#M000355">validate_option (MCollective::Application)</a><br />
- <a href="classes/MCollective/RPC/Client.html#M000089">validate_request (MCollective::RPC::Client)</a><br />
- <a href="classes/MCollective/DDL/Base.html#M000172">validate_requirements (MCollective::DDL::Base)</a><br />
- <a href="classes/MCollective/DDL/AgentDDL.html#M000187">validate_rpc_request (MCollective::DDL::AgentDDL)</a><br />
- <a href="classes/MCollective/RunnerStats.html#M000477">validated (MCollective::RunnerStats)</a><br />
- <a href="classes/MCollective/DDL.html#M000159">validation_fail! (MCollective::DDL)</a><br />
- <a href="classes/MCollective/Validator.html#M000220">validator_class (MCollective::Validator)</a><br />
- <a href="classes/MCollective/Security/Base.html#M000268">validrequest? (MCollective::Security::Base)</a><br />
- <a href="classes/MCollective/SSL.html#M000388">verify_signature (MCollective::SSL)</a><br />
- <a href="classes/MCollective.html#M000015">version (MCollective)</a><br />
- <a href="classes/MCollective/Util.html#M000306">versioncmp (MCollective::Util)</a><br />
- <a href="classes/MCollective/Log.html#M000433">warn (MCollective::Log)</a><br />
- <a href="classes/MCollective/Util.html#M000298">windows? (MCollective::Util)</a><br />
- <a href="classes/MCollective/Util.html#M000289">windows_prefix (MCollective::Util)</a><br />
- <a href="classes/MCollective/Cache.html#M000276">write (MCollective::Cache)</a><br />
- <a href="classes/MCollective/Generators/Base.html#M000259">write_plugins (MCollective::Generators::Base)</a><br />
- </div>
-</div>
-</body>
-</html>
\ No newline at end of file
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<!--
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- The Marionette Collective version 2.3.2
+ <title>mcollective version 2.3.3</title>
+
+ <link type="text/css" media="screen" href="rdoc.css" rel="stylesheet" />
+
+ <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>
- -->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>The Marionette Collective version 2.3.2</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
</head>
-<frameset rows="20%, 80%">
- <frameset cols="25%,35%,45%">
- <frame src="fr_file_index.html" title="Files" name="Files" />
- <frame src="fr_class_index.html" name="Classes" />
- <frame src="fr_method_index.html" name="Methods" />
- </frameset>
- <frame src="classes/MCollective.html" name="docwin" />
-</frameset>
-</html>
\ No newline at end of file
+<body class="indexpage">
+
+
+ <h1>mcollective version 2.3.3</h1>
+
+
+ <p>This is the API documentation for 'mcollective version 2.3.3'.</p>
+
+
+
+
+ <h2>Files</h2>
+ <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>
+
+
+ <h2>Classes/Modules</h2>
+ <ul>
+
+ <li class="module"><a href="MCollective.html">MCollective</a></li>
+
+ <li class="module"><a href="MCollective/Agent.html">MCollective::Agent</a></li>
+
+ <li class="class"><a href="MCollective/Agents.html">MCollective::Agents</a></li>
+
+ <li class="class"><a href="MCollective/Aggregate.html">MCollective::Aggregate</a></li>
+
+ <li class="class"><a href="MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
+
+ <li class="module"><a href="MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
+
+ <li class="class"><a href="MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
+
+ <li class="class"><a href="MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
+
+ <li class="class"><a href="MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
+
+ <li class="class"><a href="MCollective/Application.html">MCollective::Application</a></li>
+
+ <li class="class"><a href="MCollective/Applications.html">MCollective::Applications</a></li>
+
+ <li class="module"><a href="MCollective/Cache.html">MCollective::Cache</a></li>
+
+ <li class="class"><a href="MCollective/Client.html">MCollective::Client</a></li>
+
+ <li class="class"><a href="MCollective/CodedError.html">MCollective::CodedError</a></li>
+
+ <li class="class"><a href="MCollective/Config.html">MCollective::Config</a></li>
+
+ <li class="module"><a href="MCollective/Connector.html">MCollective::Connector</a></li>
+
+ <li class="class"><a href="MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
+
+ <li class="module"><a href="MCollective/DDL.html">MCollective::DDL</a></li>
+
+ <li class="class"><a href="MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
+
+ <li class="class"><a href="MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
+
+ <li class="class"><a href="MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
+
+ <li class="class"><a href="MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
+
+ <li class="class"><a href="MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
+
+ <li class="class"><a href="MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
+
+ <li class="module"><a href="MCollective/Data.html">MCollective::Data</a></li>
+
+ <li class="class"><a href="MCollective/Data/Base.html">MCollective::Data::Base</a></li>
+
+ <li class="class"><a href="MCollective/Data/Result.html">MCollective::Data::Result</a></li>
+
+ <li class="class"><a href="MCollective/Discovery.html">MCollective::Discovery</a></li>
+
+ <li class="module"><a href="MCollective/Facts.html">MCollective::Facts</a></li>
+
+ <li class="class"><a href="MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
+
+ <li class="module"><a href="MCollective/Generators.html">MCollective::Generators</a></li>
+
+ <li class="class"><a href="MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
+
+ <li class="class"><a href="MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
+
+ <li class="class"><a href="MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
+
+ <li class="class"><a href="MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
+
+ <li class="class"><a href="MCollective/Log.html">MCollective::Log</a></li>
+
+ <li class="module"><a href="MCollective/Logger.html">MCollective::Logger</a></li>
+
+ <li class="class"><a href="MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
+
+ <li class="class"><a href="MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
+
+ <li class="class"><a href="MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
+
+ <li class="class"><a href="MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
+
+ <li class="module"><a href="MCollective/Matcher.html">MCollective::Matcher</a></li>
+
+ <li class="class"><a href="MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
+
+ <li class="class"><a href="MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
+
+ <li class="class"><a href="MCollective/Message.html">MCollective::Message</a></li>
+
+ <li class="class"><a href="MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
+
+ <li class="class"><a href="MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
+
+ <li class="class"><a href="MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
+
+ <li class="class"><a href="MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
+
+ <li class="class"><a href="MCollective/Optionparser.html">MCollective::Optionparser</a></li>
+
+ <li class="module"><a href="MCollective/PluginManager.html">MCollective::PluginManager</a></li>
+
+ <li class="module"><a href="MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
+
+ <li class="class"><a href="MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
+
+ <li class="class"><a href="MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
+
+ <li class="module"><a href="MCollective/RPC.html">MCollective::RPC</a></li>
+
+ <li class="class"><a href="MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
+
+ <li class="class"><a href="MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
+
+ <li class="class"><a href="MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
+
+ <li class="class"><a href="MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
+
+ <li class="class"><a href="MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
+
+ <li class="class"><a href="MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
+
+ <li class="class"><a href="MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
+
+ <li class="class"><a href="MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
+
+ <li class="class"><a href="MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
+
+ <li class="class"><a href="MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
+
+ <li class="class"><a href="MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
+
+ <li class="class"><a href="MCollective/RPCError.html">MCollective::RPCError</a></li>
+
+ <li class="module"><a href="MCollective/Registration.html">MCollective::Registration</a></li>
+
+ <li class="class"><a href="MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
+
+ <li class="class"><a href="MCollective/Runner.html">MCollective::Runner</a></li>
+
+ <li class="class"><a href="MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
+
+ <li class="class"><a href="MCollective/SSL.html">MCollective::SSL</a></li>
+
+ <li class="module"><a href="MCollective/Security.html">MCollective::Security</a></li>
+
+ <li class="class"><a href="MCollective/Security/Base.html">MCollective::Security::Base</a></li>
+
+ <li class="class"><a href="MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
+
+ <li class="class"><a href="MCollective/Shell.html">MCollective::Shell</a></li>
+
+ <li class="module"><a href="MCollective/Translatable.html">MCollective::Translatable</a></li>
+
+ <li class="class"><a href="MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
+
+ <li class="class"><a href="MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
+
+ <li class="class"><a href="MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
+
+ <li class="module"><a href="MCollective/Util.html">MCollective::Util</a></li>
+
+ <li class="module"><a href="MCollective/Validator.html">MCollective::Validator</a></li>
+
+ <li class="class"><a href="MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
+
+ <li class="class"><a href="MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
+
+ <li class="class"><a href="Array.html">Array</a></li>
+
+ <li class="class"><a href="Dir.html">Dir</a></li>
+
+ <li class="class"><a href="Object.html">Object</a></li>
+
+ <li class="class"><a href="String.html">String</a></li>
+
+ <li class="class"><a href="Symbol.html">Symbol</a></li>
+
+ </ul>
+
+ <h2>Methods</h2>
+ <ul>
+
+ <li><a href="MCollective/PluginManager.html#M000073">::<< — MCollective::PluginManager</a></li>
+
+ <li><a href="MCollective/Applications.html#M000095">::[] — MCollective::Applications</a></li>
+
+ <li><a href="MCollective/Data.html#M000488">::[] — MCollective::Data</a></li>
+
+ <li><a href="MCollective/Application.html#M000003">::[] — MCollective::Application</a></li>
+
+ <li><a href="MCollective/PluginManager.html#M000080">::[] — MCollective::PluginManager</a></li>
+
+ <li><a href="MCollective/Validator.html#M000333">::[] — MCollective::Validator</a></li>
+
+ <li><a href="MCollective/PluginPackager.html#M000034">::[] — MCollective::PluginPackager</a></li>
+
+ <li><a href="MCollective/Facts.html#M000484">::[] — MCollective::Facts</a></li>
+
+ <li><a href="MCollective/Application.html#M000002">::[]= — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Util.html#M000328">::absolute_path? — MCollective::Util</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000411">::action — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000405">::actions — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000404">::activate? — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/Data/Base.html#M000196">::activate? — MCollective::Data::Base</a></li>
+
+ <li><a href="MCollective/Data/Base.html#M000189">::activate_when — MCollective::Data::Base</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000410">::activate_when — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/RPC/Helpers.html#M000453">::add_simplerpc_options — MCollective::RPC::Helpers</a></li>
+
+ <li><a href="MCollective/Agents.html#M000112">::agentlist — MCollective::Agents</a></li>
+
+ <li><a href="MCollective/Util.html#M000318">::align_text — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Application.html#M000001">::application_options — MCollective::Application</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000412">::authorized_by — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/SSL.html#M000220">::base64_decode — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/SSL.html#M000218">::base64_encode — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/Cache.html#M000340">::check_cache! — MCollective::Cache</a></li>
+
+ <li><a href="MCollective/PluginPackager.html#M000036">::check_dir_present — MCollective::PluginPackager</a></li>
+
+ <li><a href="MCollective/Log.html#M000124">::check_level — MCollective::Log</a></li>
+
+ <li><a href="MCollective/PluginManager.html#M000079">::clear — MCollective::PluginManager</a></li>
+
+ <li><a href="MCollective/Util.html#M000313">::color — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Util.html#M000315">::colorize — MCollective::Util</a></li>
+
+ <li><a href="MCollective/PluginPackager.html#M000038">::command_available? — MCollective::PluginPackager</a></li>
+
+ <li><a href="MCollective/Util.html#M000325">::command_in_path? — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Log.html#M000123">::config_and_check_level — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Util.html#M000303">::config_file_for_user — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Log.html#M000131">::configure — MCollective::Log</a></li>
+
+ <li><a href="MCollective/RPC.html#M000327">::const_missing — MCollective::RPC</a></li>
+
+ <li><a href="MCollective/Matcher.html#M000065">::create_compound_callstack — MCollective::Matcher</a></li>
+
+ <li><a href="MCollective/Matcher.html#M000052">::create_function_hash — MCollective::Matcher</a></li>
+
+ <li><a href="MCollective/PluginManager.html#M000081">::create_instance — MCollective::PluginManager</a></li>
+
+ <li><a href="MCollective/Log.html#M000122">::cycle_level — MCollective::Log</a></li>
+
+ <li><a href="MCollective/UnixDaemon.html#M000346">::daemonize — MCollective::UnixDaemon</a></li>
+
+ <li><a href="MCollective/WindowsDaemon.html#M000350">::daemonize_runner — MCollective::WindowsDaemon</a></li>
+
+ <li><a href="MCollective/UnixDaemon.html#M000347">::daemonize_runner — MCollective::UnixDaemon</a></li>
+
+ <li><a href="MCollective/Data.html#M000490">::ddl — MCollective::Data</a></li>
+
+ <li><a href="MCollective/Data.html#M000492">::ddl_has_output? — MCollective::Data</a></li>
+
+ <li><a href="MCollective/Data.html#M000493">::ddl_transform_input — MCollective::Data</a></li>
+
+ <li><a href="MCollective/Data.html#M000491">::ddl_validate — MCollective::Data</a></li>
+
+ <li><a href="MCollective/Log.html#M000118">::debug — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Util.html#M000304">::default_options — MCollective::Util</a></li>
+
+ <li><a href="MCollective/PluginManager.html#M000074">::delete — MCollective::PluginManager</a></li>
+
+ <li><a href="MCollective/Cache.html#M000342">::delete! — MCollective::Cache</a></li>
+
+ <li><a href="MCollective/Application.html#M000004">::description — MCollective::Application</a></li>
+
+ <li><a href="MCollective/RPC.html#M000320">::discovered — MCollective::RPC</a></li>
+
+ <li><a href="MCollective/Util.html#M000301">::empty_filter — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Util.html#M000300">::empty_filter? — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Log.html#M000120">::error — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Matcher.html#M000059">::eval_compound_fstatement — MCollective::Matcher</a></li>
+
+ <li><a href="MCollective/Matcher.html#M000054">::eval_compound_statement — MCollective::Matcher</a></li>
+
+ <li><a href="MCollective/Application.html#M000006">::exclude_argument_sections — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Matcher.html#M000053">::execute_function — MCollective::Matcher</a></li>
+
+ <li><a href="MCollective/PluginPackager.html#M000037">::execute_verbosely — MCollective::PluginPackager</a></li>
+
+ <li><a href="MCollective/Log.html#M000134">::execution_stack — MCollective::Log</a></li>
+
+ <li><a href="MCollective/RPC/Helpers.html#M000442">::extract_hosts_from_array — MCollective::RPC::Helpers</a></li>
+
+ <li><a href="MCollective/RPC/Helpers.html#M000441">::extract_hosts_from_json — MCollective::RPC::Helpers</a></li>
+
+ <li><a href="MCollective/Log.html#M000119">::fatal — MCollective::Log</a></li>
+
+ <li><a href="MCollective/PluginPackager.html#M000040">::filter_dependencies — MCollective::PluginPackager</a></li>
+
+ <li><a href="MCollective/Applications.html#M000099">::filter_extra_options — MCollective::Applications</a></li>
+
+ <li><a href="MCollective/PluginManager.html#M000082">::find — MCollective::PluginManager</a></li>
+
+ <li><a href="MCollective/PluginManager.html#M000083">::find_and_load — MCollective::PluginManager</a></li>
+
+ <li><a href="MCollective/Log.html#M000133">::from — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Facts.html#M000483">::get_fact — MCollective::Facts</a></li>
+
+ <li><a href="MCollective/Util.html#M000297">::get_fact — MCollective::Util</a></li>
+
+ <li><a href="MCollective/PluginPackager.html#M000035">::get_metadata — MCollective::PluginPackager</a></li>
+
+ <li><a href="MCollective/PluginManager.html#M000085">::grep — MCollective::PluginManager</a></li>
+
+ <li><a href="MCollective/Util.html#M000294">::has_agent? — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Cache.html#M000341">::has_cache? — MCollective::Cache</a></li>
+
+ <li><a href="MCollective/Util.html#M000296">::has_cf_class? — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Facts.html#M000482">::has_fact? — MCollective::Facts</a></li>
+
+ <li><a href="MCollective/Util.html#M000298">::has_fact? — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Util.html#M000299">::has_identity? — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Validator.html#M000335">::has_validator? — MCollective::Validator</a></li>
+
+ <li><a href="MCollective/PluginManager.html#M000075">::include? — MCollective::PluginManager</a></li>
+
+ <li><a href="MCollective/Log.html#M000116">::info — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Security/Base.html#M000353">::inherited — MCollective::Security::Base</a></li>
+
+ <li><a href="MCollective/Facts/Base.html#M000260">::inherited — MCollective::Facts::Base</a></li>
+
+ <li><a href="MCollective/Data/Base.html#M000184">::inherited — MCollective::Data::Base</a></li>
+
+ <li><a href="MCollective/Connector/Base.html#M000293">::inherited — MCollective::Connector::Base</a></li>
+
+ <li><a href="MCollective/Registration/Base.html#M000151">::inherited — MCollective::Registration::Base</a></li>
+
+ <li><a href="MCollective/RPC/Audit.html#M000408">::inherited — MCollective::RPC::Audit</a></li>
+
+ <li><a href="MCollective/Log.html#M000121">::instance — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Application.html#M000008">::intialize_application_options — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Cache.html#M000349">::invalidate! — MCollective::Cache</a></li>
+
+ <li><a href="MCollective/Applications.html#M000098">::list — MCollective::Applications</a></li>
+
+ <li><a href="MCollective/DDL.html#M000368">::load_and_cache — MCollective::DDL</a></li>
+
+ <li><a href="MCollective/Applications.html#M000097">::load_application — MCollective::Applications</a></li>
+
+ <li><a href="MCollective/Applications.html#M000100">::load_config — MCollective::Applications</a></li>
+
+ <li><a href="MCollective/Data.html#M000486">::load_data_sources — MCollective::Data</a></li>
+
+ <li><a href="MCollective/PluginPackager.html#M000033">::load_packagers — MCollective::PluginPackager</a></li>
+
+ <li><a href="MCollective/Validator.html#M000332">::load_validators — MCollective::Validator</a></li>
+
+ <li><a href="MCollective/Validator.html#M000337">::load_validators? — MCollective::Validator</a></li>
+
+ <li><a href="MCollective/Util.html#M000308">::loadclass — MCollective::Util</a></li>
+
+ <li><a href="MCollective/PluginManager.html#M000084">::loadclass — MCollective::PluginManager</a></li>
+
+ <li><a href="MCollective/Log.html#M000129">::log — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Log.html#M000127">::logexception — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Log.html#M000115">::logger — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Log.html#M000128">::logmsg — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Util.html#M000305">::make_subscriptions — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Util.html#M000317">::mcollective_version — MCollective::Util</a></li>
+
+ <li><a href="MCollective/SSL.html#M000222">::md5 — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/Log.html#M000126">::message_for — MCollective::Log</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000407">::metadata — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/Validator.html#M000334">::method_missing — MCollective::Validator</a></li>
+
+ <li><a href="MCollective/Data.html#M000489">::method_missing — MCollective::Data</a></li>
+
+ <li><a href="Dir.html#M000203">::mktmpdir — Dir</a></li>
+
+ <li><a href="MCollective/DDL/Base.html#M000278">::new — MCollective::DDL::Base</a></li>
+
+ <li><a href="MCollective/SSL.html#M000202">::new — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/RPC/Progress.html#M000391">::new — MCollective::RPC::Progress</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000443">::new — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Data/Result.html#M000190">::new — MCollective::Data::Result</a></li>
+
+ <li><a href="MCollective/RPC/Request.html#M000396">::new — MCollective::RPC::Request</a></li>
+
+ <li><a href="MCollective/Matcher/Scanner.html#M000041">::new — MCollective::Matcher::Scanner</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000420">::new — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/RPC/Reply.html#M000383">::new — MCollective::RPC::Reply</a></li>
+
+ <li><a href="MCollective/RunnerStats.html#M000225">::new — MCollective::RunnerStats</a></li>
+
+ <li><a href="MCollective/Matcher/Parser.html#M000044">::new — MCollective::Matcher::Parser</a></li>
+
+ <li><a href="MCollective/PluginPackager/StandardDefinition.html#M000086">::new — MCollective::PluginPackager::StandardDefinition</a></li>
+
+ <li><a href="MCollective/Generators/AgentGenerator.html#M000245">::new — MCollective::Generators::AgentGenerator</a></li>
+
+ <li><a href="MCollective/Facts/Base.html#M000259">::new — MCollective::Facts::Base</a></li>
+
+ <li><a href="MCollective/RPC/ActionRunner.html#M000372">::new — MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="MCollective/CodedError.html#M000506">::new — MCollective::CodedError</a></li>
+
+ <li><a href="MCollective/Client.html#M000494">::new — MCollective::Client</a></li>
+
+ <li><a href="MCollective/Agents.html#M000101">::new — MCollective::Agents</a></li>
+
+ <li><a href="MCollective/Config.html#M000110">::new — MCollective::Config</a></li>
+
+ <li><a href="MCollective/RPC/Result.html#M000428">::new — MCollective::RPC::Result</a></li>
+
+ <li><a href="MCollective/Security/Base.html#M000354">::new — MCollective::Security::Base</a></li>
+
+ <li><a href="MCollective/Discovery.html#M000141">::new — MCollective::Discovery</a></li>
+
+ <li><a href="MCollective/DDL.html#M000367">::new — MCollective::DDL</a></li>
+
+ <li><a href="MCollective/Runner.html#M000069">::new — MCollective::Runner</a></li>
+
+ <li><a href="MCollective/Optionparser.html#M000020">::new — MCollective::Optionparser</a></li>
+
+ <li><a href="MCollective/PluginPackager/AgentDefinition.html#M000090">::new — MCollective::PluginPackager::AgentDefinition</a></li>
+
+ <li><a href="MCollective/Data/Base.html#M000185">::new — MCollective::Data::Base</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000393">::new — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/DDL/AgentDDL.html#M000266">::new — MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="MCollective/Logger/Base.html#M000166">::new — MCollective::Logger::Base</a></li>
+
+ <li><a href="MCollective/Message.html#M000051">::new — MCollective::Message</a></li>
+
+ <li><a href="MCollective/Shell.html#M000358">::new — MCollective::Shell</a></li>
+
+ <li><a href="MCollective/Aggregate/Result/Base.html#M000252">::new — MCollective::Aggregate::Result::Base</a></li>
+
+ <li><a href="MCollective/Aggregate/Base.html#M000249">::new — MCollective::Aggregate::Base</a></li>
+
+ <li><a href="MCollective/Generators/Base.html#M000238">::new — MCollective::Generators::Base</a></li>
+
+ <li><a href="MCollective/Aggregate.html#M000135">::new — MCollective::Aggregate</a></li>
+
+ <li><a href="MCollective/Generators/DataGenerator.html#M000242">::new — MCollective::Generators::DataGenerator</a></li>
+
+ <li><a href="MCollective/RPC/Helpers.html#M000451">::old_rpcresults — MCollective::RPC::Helpers</a></li>
+
+ <li><a href="MCollective/Application.html#M000007">::option — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Util.html#M000309">::parse_fact_string — MCollective::Util</a></li>
+
+ <li><a href="MCollective/PluginManager.html#M000076">::pluginlist — MCollective::PluginManager</a></li>
+
+ <li><a href="MCollective/Data.html#M000487">::pluginname — MCollective::Data</a></li>
+
+ <li><a href="MCollective/Data/Base.html#M000187">::query — MCollective::Data::Base</a></li>
+
+ <li><a href="MCollective/Cache.html#M000344">::read — MCollective::Cache</a></li>
+
+ <li><a href="MCollective/RPC/Helpers.html#M000444">::rpcresults — MCollective::RPC::Helpers</a></li>
+
+ <li><a href="MCollective/Util.html#M000316">::ruby_version — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Applications.html#M000096">::run — MCollective::Applications</a></li>
+
+ <li><a href="MCollective/PluginPackager.html#M000039">::safe_system — MCollective::PluginPackager</a></li>
+
+ <li><a href="MCollective/Log.html#M000130">::set_logger — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Cache.html#M000339">::setup — MCollective::Cache</a></li>
+
+ <li><a href="MCollective/Util.html#M000295">::setup_windows_sleeper — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Util.html#M000311">::shellescape — MCollective::Util</a></li>
+
+ <li><a href="MCollective/RPC.html#M000319">::stats — MCollective::RPC</a></li>
+
+ <li><a href="MCollective/Util.html#M000329">::str_to_bool — MCollective::Util</a></li>
+
+ <li><a href="MCollective/DDL.html#M000369">::string_to_boolean — MCollective::DDL</a></li>
+
+ <li><a href="MCollective/DDL.html#M000370">::string_to_number — MCollective::DDL</a></li>
+
+ <li><a href="MCollective/Util.html#M000306">::subscribe — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Cache.html#M000348">::synchronize — MCollective::Cache</a></li>
+
+ <li><a href="MCollective/Util.html#M000330">::t — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Util.html#M000331">::templatepath — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Util.html#M000322">::terminal_dimensions — MCollective::Util</a></li>
+
+ <li><a href="MCollective/RPC/Helpers.html#M000450">::text_for_flattened_result — MCollective::RPC::Helpers</a></li>
+
+ <li><a href="MCollective/RPC/Helpers.html#M000445">::text_for_result — MCollective::RPC::Helpers</a></li>
+
+ <li><a href="Dir.html#M000204">::tmpdir — Dir</a></li>
+
+ <li><a href="MCollective/Cache.html#M000345">::ttl — MCollective::Cache</a></li>
+
+ <li><a href="MCollective/Log.html#M000132">::unconfigure — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Util.html#M000307">::unsubscribe — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Application.html#M000005">::usage — MCollective::Application</a></li>
+
+ <li><a href="MCollective/SSL.html#M000223">::uuid — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/Log.html#M000125">::valid_level? — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Validator.html#M000338">::validate — MCollective::Validator</a></li>
+
+ <li><a href="MCollective/DDL.html#M000371">::validation_fail! — MCollective::DDL</a></li>
+
+ <li><a href="MCollective/Validator.html#M000336">::validator_class — MCollective::Validator</a></li>
+
+ <li><a href="MCollective.html#M000000">::version — MCollective</a></li>
+
+ <li><a href="MCollective/Util.html#M000326">::versioncmp — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Log.html#M000117">::warn — MCollective::Log</a></li>
+
+ <li><a href="MCollective/Util.html#M000312">::windows? — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Util.html#M000302">::windows_prefix — MCollective::Util</a></li>
+
+ <li><a href="MCollective/Cache.html#M000343">::write — MCollective::Cache</a></li>
+
+ <li><a href="Symbol.html#M000199">#<=> — Symbol</a></li>
+
+ <li><a href="MCollective/Data/Result.html#M000192">#[] — MCollective::Data::Result</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000423">#[] — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/RPC/Request.html#M000399">#[] — MCollective::RPC::Request</a></li>
+
+ <li><a href="MCollective/RPC/Result.html#M000429">#[] — MCollective::RPC::Result</a></li>
+
+ <li><a href="MCollective/RPC/Reply.html#M000388">#[] — MCollective::RPC::Reply</a></li>
+
+ <li><a href="MCollective/RPC/Result.html#M000430">#[]= — MCollective::RPC::Result</a></li>
+
+ <li><a href="MCollective/RPC/Reply.html#M000387">#[]= — MCollective::RPC::Reply</a></li>
+
+ <li><a href="MCollective/Data/Result.html#M000193">#[]= — MCollective::Data::Result</a></li>
+
+ <li><a href="MCollective/DDL/AgentDDL.html#M000271">#action — MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="MCollective/Generators/AgentGenerator.html#M000248">#action_help — MCollective::Generators::AgentGenerator</a></li>
+
+ <li><a href="MCollective/DDL/AgentDDL.html#M000276">#action_interface — MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="MCollective/DDL/AgentDDL.html#M000277">#actions — MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="MCollective/Agents.html#M000106">#activate_agent? — MCollective::Agents</a></li>
+
+ <li><a href="MCollective/Optionparser.html#M000031">#add_common_options — MCollective::Optionparser</a></li>
+
+ <li><a href="MCollective/Optionparser.html#M000024">#add_filter_options — MCollective::Optionparser</a></li>
+
+ <li><a href="MCollective/Optionparser.html#M000028">#add_required_options — MCollective::Optionparser</a></li>
+
+ <li><a href="MCollective/SSL.html#M000214">#aes_decrypt — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/SSL.html#M000213">#aes_encrypt — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000418">#after_processing_hook — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/PluginPackager/AgentDefinition.html#M000092">#agent — MCollective::PluginPackager::AgentDefinition</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000461">#agent_filter — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Runner.html#M000071">#agentmsg — MCollective::Runner</a></li>
+
+ <li><a href="MCollective/DDL/AgentDDL.html#M000269">#aggregate — MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000475">#aggregate_reply — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Application.html#M000018">#application_cli_arguments — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Application.html#M000016">#application_description — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Application.html#M000019">#application_failure — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Application.html#M000015">#application_options — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Application.html#M000013">#application_parse_options — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Application.html#M000017">#application_usage — MCollective::Application</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000419">#audit_request — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/RPC/Audit.html#M000409">#audit_request — MCollective::RPC::Audit</a></li>
+
+ <li><a href="MCollective/Message.html#M000061">#base64? — MCollective::Message</a></li>
+
+ <li><a href="MCollective/SSL.html#M000219">#base64_decode — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/Message.html#M000058">#base64_decode! — MCollective::Message</a></li>
+
+ <li><a href="MCollective/SSL.html#M000217">#base64_encode — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/Message.html#M000060">#base64_encode! — MCollective::Message</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000471">#batch_size= — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000472">#batch_sleep_time= — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000417">#before_processing_hook — MCollective::RPC::Agent</a></li>
+
+ <li><a href="Object.html#M000520">#build_rdoc — Object</a></li>
+
+ <li><a href="String.html#M000201">#bytes — String</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000480">#call_agent — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000479">#call_agent_batched — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Aggregate.html#M000138">#call_functions — MCollective::Aggregate</a></li>
+
+ <li><a href="MCollective/Security/Base.html#M000361">#callerid — MCollective::Security::Base</a></li>
+
+ <li><a href="MCollective/RPC/ActionRunner.html#M000379">#canrun? — MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="MCollective/DDL/DiscoveryDDL.html#M000258">#capabilities — MCollective::DDL::DiscoveryDDL</a></li>
+
+ <li><a href="MCollective/Discovery.html#M000148">#check_capabilities — MCollective::Discovery</a></li>
+
+ <li><a href="Object.html#M000515">#check_prereqs — Object</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000459">#class_filter — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Agents.html#M000105">#class_for_agent — MCollective::Agents</a></li>
+
+ <li><a href="MCollective/Agents.html#M000102">#clear! — MCollective::Agents</a></li>
+
+ <li><a href="MCollective/PluginPackager/AgentDefinition.html#M000093">#client — MCollective::PluginPackager::AgentDefinition</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000426">#client_stats= — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/Application.html#M000012">#clioptions — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Client.html#M000495">#collective — MCollective::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000468">#collective= — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Logger/Console_logger.html#M000164">#color — MCollective::Logger::Console_logger</a></li>
+
+ <li><a href="MCollective/Logger/Console_logger.html#M000165">#colorize — MCollective::Logger::Console_logger</a></li>
+
+ <li><a href="MCollective/PluginPackager/AgentDefinition.html#M000094">#common — MCollective::PluginPackager::AgentDefinition</a></li>
+
+ <li><a href="MCollective/PluginPackager/StandardDefinition.html#M000089">#common — MCollective::PluginPackager::StandardDefinition</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000463">#compound_filter — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Registration/Base.html#M000153">#config — MCollective::Registration::Base</a></li>
+
+ <li><a href="MCollective/Application.html#M000009">#configuration — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Aggregate.html#M000137">#contains_output? — MCollective::Aggregate</a></li>
+
+ <li><a href="MCollective/Runner.html#M000072">#controlmsg — MCollective::Runner</a></li>
+
+ <li><a href="MCollective/Generators/AgentGenerator.html#M000246">#create_ddl — MCollective::Generators::AgentGenerator</a></li>
+
+ <li><a href="MCollective/Generators/DataGenerator.html#M000243">#create_ddl — MCollective::Generators::DataGenerator</a></li>
+
+ <li><a href="MCollective/Aggregate.html#M000136">#create_functions — MCollective::Aggregate</a></li>
+
+ <li><a href="MCollective/Generators/Base.html#M000239">#create_metadata_string — MCollective::Generators::Base</a></li>
+
+ <li><a href="MCollective/Generators/DataGenerator.html#M000244">#create_plugin_content — MCollective::Generators::DataGenerator</a></li>
+
+ <li><a href="MCollective/Generators/AgentGenerator.html#M000247">#create_plugin_content — MCollective::Generators::AgentGenerator</a></li>
+
+ <li><a href="MCollective/Generators/Base.html#M000240">#create_plugin_string — MCollective::Generators::Base</a></li>
+
+ <li><a href="MCollective/Security/Base.html#M000356">#create_reply — MCollective::Security::Base</a></li>
+
+ <li><a href="MCollective/Message.html#M000068">#create_reqid — MCollective::Message</a></li>
+
+ <li><a href="MCollective/Security/Base.html#M000357">#create_request — MCollective::Security::Base</a></li>
+
+ <li><a href="MCollective/Client.html#M000498">#createreq — MCollective::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000454">#custom_request — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Logger/Base.html#M000168">#cycle_level — MCollective::Logger::Base</a></li>
+
+ <li><a href="MCollective/DDL/DataDDL.html#M000286">#dataquery — MCollective::DDL::DataDDL</a></li>
+
+ <li><a href="MCollective/DDL/DataDDL.html#M000289">#dataquery_interface — MCollective::DDL::DataDDL</a></li>
+
+ <li><a href="MCollective/Discovery.html#M000147">#ddl — MCollective::Discovery</a></li>
+
+ <li><a href="MCollective/Data/Base.html#M000188">#ddl_validate — MCollective::Data::Base</a></li>
+
+ <li><a href="MCollective/Message.html#M000064">#decode! — MCollective::Message</a></li>
+
+ <li><a href="MCollective/Security/Base.html#M000366">#decodemsg — MCollective::Security::Base</a></li>
+
+ <li><a href="MCollective/SSL.html#M000207">#decrypt_with_private — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/SSL.html#M000208">#decrypt_with_public — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/Application.html#M000025">#disconnect — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Client.html#M000496">#disconnect — MCollective::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000446">#disconnect — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000466">#discover — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Discovery.html#M000156">#discover — MCollective::Discovery</a></li>
+
+ <li><a href="MCollective/Client.html#M000502">#discover — MCollective::Client</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000435">#discovered_agents — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/Client.html#M000512">#discovered_req — MCollective::Client</a></li>
+
+ <li><a href="MCollective/DDL/DiscoveryDDL.html#M000262">#discovery — MCollective::DDL::DiscoveryDDL</a></li>
+
+ <li><a href="MCollective/Discovery.html#M000146">#discovery_class — MCollective::Discovery</a></li>
+
+ <li><a href="MCollective/DDL/DiscoveryDDL.html#M000257">#discovery_interface — MCollective::DDL::DiscoveryDDL</a></li>
+
+ <li><a href="MCollective/Discovery.html#M000145">#discovery_method — MCollective::Discovery</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000457">#discovery_method= — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000458">#discovery_options= — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Discovery.html#M000155">#discovery_timeout — MCollective::Discovery</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000455">#discovery_timeout — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000456">#discovery_timeout= — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Agents.html#M000109">#dispatch — MCollective::Agents</a></li>
+
+ <li><a href="MCollective/DDL/AgentDDL.html#M000270">#display — MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="MCollective/Client.html#M000513">#display_stats — MCollective::Client</a></li>
+
+ <li><a href="Object.html#M000517">#do_bins — Object</a></li>
+
+ <li><a href="Object.html#M000516">#do_configs — Object</a></li>
+
+ <li><a href="Object.html#M000518">#do_libs — Object</a></li>
+
+ <li><a href="MCollective/RPC/Result.html#M000432">#each — MCollective::RPC::Result</a></li>
+
+ <li><a href="MCollective/RPC.html#M000324">#empty_filter? — MCollective::RPC</a></li>
+
+ <li><a href="MCollective/Message.html#M000062">#encode! — MCollective::Message</a></li>
+
+ <li><a href="MCollective/Security/Base.html#M000364">#encodereply — MCollective::Security::Base</a></li>
+
+ <li><a href="MCollective/Security/Base.html#M000363">#encoderequest — MCollective::Security::Base</a></li>
+
+ <li><a href="MCollective/SSL.html#M000206">#encrypt_with_private — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/SSL.html#M000205">#encrypt_with_public — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/Matcher/Parser.html#M000047">#exit_with_paren_errors — MCollective::Matcher::Parser</a></li>
+
+ <li><a href="MCollective/Matcher/Parser.html#M000046">#exit_with_parse_errors — MCollective::Matcher::Parser</a></li>
+
+ <li><a href="MCollective/Matcher/Parser.html#M000045">#exit_with_token_errors — MCollective::Matcher::Parser</a></li>
+
+ <li><a href="MCollective/Message.html#M000057">#expected_msgid= — MCollective::Message</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000460">#fact_filter — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Reply.html#M000385">#fail — MCollective::RPC::Reply</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000425">#fail — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/RPC/Reply.html#M000386">#fail! — MCollective::RPC::Reply</a></li>
+
+ <li><a href="MCollective/RPC/Result.html#M000431">#fetch — MCollective::RPC::Result</a></li>
+
+ <li><a href="MCollective/RPC/Request.html#M000400">#fetch — MCollective::RPC::Request</a></li>
+
+ <li><a href="MCollective/RPC/Reply.html#M000389">#fetch — MCollective::RPC::Reply</a></li>
+
+ <li><a href="MCollective/RunnerStats.html#M000228">#filtered — MCollective::RunnerStats</a></li>
+
+ <li><a href="MCollective/Discovery.html#M000142">#find_known_methods — MCollective::Discovery</a></li>
+
+ <li><a href="MCollective/Agents.html#M000107">#findagentfile — MCollective::Agents</a></li>
+
+ <li><a href="MCollective/DDL/Base.html#M000283">#findddlfile — MCollective::DDL::Base</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000436">#finish_request — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000477">#fire_and_forget_request — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Discovery.html#M000144">#force_direct_mode? — MCollective::Discovery</a></li>
+
+ <li><a href="MCollective/Discovery.html#M000149">#force_discovery_method_by_filter — MCollective::Discovery</a></li>
+
+ <li><a href="MCollective/Facts/Base.html#M000265">#force_reload? — MCollective::Facts::Base</a></li>
+
+ <li><a href="MCollective/Matcher/Scanner.html#M000043">#gen_statement — MCollective::Matcher::Scanner</a></li>
+
+ <li><a href="MCollective/Facts/Base.html#M000261">#get_fact — MCollective::Facts::Base</a></li>
+
+ <li><a href="MCollective/Facts/Base.html#M000263">#get_facts — MCollective::Facts::Base</a></li>
+
+ <li><a href="MCollective/Logger/Base.html#M000171">#get_next_level — MCollective::Logger::Base</a></li>
+
+ <li><a href="MCollective/Matcher/Scanner.html#M000042">#get_token — MCollective::Matcher::Scanner</a></li>
+
+ <li><a href="Object.html#M000514">#glob — Object</a></li>
+
+ <li><a href="MCollective/Application.html#M000029">#halt — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Application.html#M000027">#halt_code — MCollective::Application</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000395">#handlemsg — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/Facts/Base.html#M000264">#has_fact? — MCollective::Facts::Base</a></li>
+
+ <li><a href="MCollective/Discovery.html#M000143">#has_method? — MCollective::Discovery</a></li>
+
+ <li><a href="MCollective/Application.html#M000022">#help — MCollective::Application</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000447">#help — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/DDL/Base.html#M000279">#help — MCollective::DDL::Base</a></li>
+
+ <li><a href="MCollective/PluginPackager/StandardDefinition.html#M000087">#identify_packages — MCollective::PluginPackager::StandardDefinition</a></li>
+
+ <li><a href="MCollective/PluginPackager/AgentDefinition.html#M000091">#identify_packages — MCollective::PluginPackager::AgentDefinition</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000462">#identity_filter — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000478">#identity_filter_discovery_optimization — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000415">#implemented_by — MCollective::RPC::Agent</a></li>
+
+ <li><a href="Array.html#M000200">#in_groups_of — Array</a></li>
+
+ <li><a href="MCollective/RPC/Request.html#M000397">#include? — MCollective::RPC::Request</a></li>
+
+ <li><a href="MCollective/Agents.html#M000108">#include? — MCollective::Agents</a></li>
+
+ <li><a href="MCollective/Data/Result.html#M000191">#include? — MCollective::Data::Result</a></li>
+
+ <li><a href="MCollective/RPC/Reply.html#M000384">#initialize_data — MCollective::RPC::Reply</a></li>
+
+ <li><a href="MCollective/DDL/DataDDL.html#M000287">#input — MCollective::DDL::DataDDL</a></li>
+
+ <li><a href="MCollective/DDL/AgentDDL.html#M000267">#input — MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="MCollective/DDL/Base.html#M000288">#input — MCollective::DDL::Base</a></li>
+
+ <li><a href="Object.html#M000521">#install_binfile — Object</a></li>
+
+ <li><a href="MCollective/Registration/Base.html#M000158">#interval — MCollective::Registration::Base</a></li>
+
+ <li><a href="MCollective/DDL/AgentDDL.html#M000273">#is_function? — MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="MCollective/Matcher/Scanner.html#M000049">#is_klass? — MCollective::Matcher::Scanner</a></li>
+
+ <li><a href="MCollective/Data/Result.html#M000194">#keys — MCollective::Data::Result</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000470">#limit_method= — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000469">#limit_targets= — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000474">#load_aggregate_functions — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000394">#load_ddl — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/Aggregate.html#M000140">#load_function — MCollective::Aggregate</a></li>
+
+ <li><a href="MCollective/RPC/ActionRunner.html#M000376">#load_json_results — MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="MCollective/RPC/ActionRunner.html#M000375">#load_results — MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="MCollective/Agents.html#M000104">#loadagent — MCollective::Agents</a></li>
+
+ <li><a href="MCollective/Agents.html#M000103">#loadagents — MCollective::Agents</a></li>
+
+ <li><a href="MCollective/Config.html#M000111">#loadconfig — MCollective::Config</a></li>
+
+ <li><a href="MCollective/DDL/Base.html#M000282">#loadddlfile — MCollective::DDL::Base</a></li>
+
+ <li><a href="MCollective/Logger/Console_logger.html#M000163">#log — MCollective::Logger::Console_logger</a></li>
+
+ <li><a href="MCollective/Logger/File_logger.html#M000183">#log — MCollective::Logger::File_logger</a></li>
+
+ <li><a href="MCollective/Logger/Syslog_logger.html#M000179">#log — MCollective::Logger::Syslog_logger</a></li>
+
+ <li><a href="MCollective/Logger/Base.html#M000173">#log — MCollective::Logger::Base</a></li>
+
+ <li><a href="MCollective/CodedError.html#M000508">#log — MCollective::CodedError</a></li>
+
+ <li><a href="MCollective/Translatable.html#M000235">#log_code — MCollective::Translatable</a></li>
+
+ <li><a href="MCollective/Translatable.html#M000237">#logexception — MCollective::Translatable</a></li>
+
+ <li><a href="MCollective/Matcher/Scanner.html#M000050">#lookahead — MCollective::Matcher::Scanner</a></li>
+
+ <li><a href="MCollective/Data/Base.html#M000186">#lookup — MCollective::Data::Base</a></li>
+
+ <li><a href="MCollective/Application.html#M000026">#main — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Logger/Base.html#M000170">#map_level — MCollective::Logger::Base</a></li>
+
+ <li><a href="MCollective/SSL.html#M000221">#md5 — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/DDL/Base.html#M000292">#metadata — MCollective::DDL::Base</a></li>
+
+ <li><a href="MCollective/Data/Result.html#M000195">#method_missing — MCollective::Data::Result</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000452">#method_missing — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/DDL/AgentDDL.html#M000272">#method_missing — MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="MCollective/Registration/Base.html#M000154">#msg_filter — MCollective::Registration::Base</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000448">#new_request — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000440">#no_response_report — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000437">#node_responded — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000424">#ok — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000467">#options — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Application.html#M000010">#options — MCollective::Application</a></li>
+
+ <li><a href="MCollective/DDL/Base.html#M000290">#output — MCollective::DDL::Base</a></li>
+
+ <li><a href="MCollective/Optionparser.html#M000021">#parse — MCollective::Optionparser</a></li>
+
+ <li><a href="MCollective/Matcher/Parser.html#M000048">#parse — MCollective::Matcher::Parser</a></li>
+
+ <li><a href="MCollective/Optionparser.html#M000032">#parse_fact — MCollective::Optionparser</a></li>
+
+ <li><a href="MCollective/RunnerStats.html#M000227">#passed — MCollective::RunnerStats</a></li>
+
+ <li><a href="MCollective/RPC/ActionRunner.html#M000382">#path_to_command — MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000473">#pick_nodes_from_discovered — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/PluginPackager/StandardDefinition.html#M000088">#plugin — MCollective::PluginPackager::StandardDefinition</a></li>
+
+ <li><a href="Object.html#M000519">#prepare_installation — Object</a></li>
+
+ <li><a href="MCollective/RPC.html#M000323">#printrpc — MCollective::RPC</a></li>
+
+ <li><a href="MCollective/RPC.html#M000321">#printrpcstats — MCollective::RPC</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000485">#process_results_with_block — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000481">#process_results_without_block — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Message.html#M000067">#publish — MCollective::Message</a></li>
+
+ <li><a href="MCollective/Registration/Base.html#M000159">#publish — MCollective::Registration::Base</a></li>
+
+ <li><a href="MCollective/Translatable.html#M000236">#raise_code — MCollective::Translatable</a></li>
+
+ <li><a href="MCollective/SSL.html#M000224">#read_key — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/Config.html#M000114">#read_plugin_config_dir — MCollective::Config</a></li>
+
+ <li><a href="MCollective/Client.html#M000501">#receive — MCollective::Client</a></li>
+
+ <li><a href="MCollective/Runner.html#M000077">#receive — MCollective::Runner</a></li>
+
+ <li><a href="MCollective/RunnerStats.html#M000231">#received — MCollective::RunnerStats</a></li>
+
+ <li><a href="MCollective/Runner.html#M000078">#reply — MCollective::Runner</a></li>
+
+ <li><a href="MCollective/Message.html#M000056">#reply_to= — MCollective::Message</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000439">#report — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/Client.html#M000503">#req — MCollective::Client</a></li>
+
+ <li><a href="MCollective/DDL/Base.html#M000291">#requires — MCollective::DDL::Base</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000421">#reset — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000464">#reset — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000465">#reset_filter — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Aggregate/Base.html#M000251">#result_class — MCollective::Aggregate::Base</a></li>
+
+ <li><a href="MCollective/Aggregate/Result/Base.html#M000254">#result_type — MCollective::Aggregate::Result::Base</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000476">#rpc_result_from_reply — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/Application.html#M000030">#rpcclient — MCollective::Application</a></li>
+
+ <li><a href="MCollective/RPC.html#M000314">#rpcclient — MCollective::RPC</a></li>
+
+ <li><a href="MCollective/RPC.html#M000310">#rpcoptions — MCollective::RPC</a></li>
+
+ <li><a href="MCollective/SSL.html#M000210">#rsa_decrypt_with_private — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/SSL.html#M000212">#rsa_decrypt_with_public — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/SSL.html#M000211">#rsa_encrypt_with_private — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/SSL.html#M000209">#rsa_encrypt_with_public — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/Application.html#M000023">#run — MCollective::Application</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000406">#run — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/Runner.html#M000070">#run — MCollective::Runner</a></li>
+
+ <li><a href="MCollective/RPC/ActionRunner.html#M000373">#run — MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="MCollective/Registration/Base.html#M000152">#run — MCollective::Registration::Base</a></li>
+
+ <li><a href="MCollective/Shell.html#M000365">#runcommand — MCollective::Shell</a></li>
+
+ <li><a href="MCollective/RPC/ActionRunner.html#M000378">#save_json_request — MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="MCollective/RPC/ActionRunner.html#M000377">#saverequest — MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="MCollective/Client.html#M000497">#sendreq — MCollective::Client</a></li>
+
+ <li><a href="MCollective/RunnerStats.html#M000232">#sent — MCollective::RunnerStats</a></li>
+
+ <li><a href="MCollective/WindowsDaemon.html#M000351">#service_main — MCollective::WindowsDaemon</a></li>
+
+ <li><a href="MCollective/WindowsDaemon.html#M000352">#service_stop — MCollective::WindowsDaemon</a></li>
+
+ <li><a href="MCollective/CodedError.html#M000507">#set_backtrace — MCollective::CodedError</a></li>
+
+ <li><a href="MCollective/Config.html#M000113">#set_config_defaults — MCollective::Config</a></li>
+
+ <li><a href="MCollective/DDL/AgentDDL.html#M000274">#set_default_input_arguments — MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="MCollective/Logger/Base.html#M000169">#set_level — MCollective::Logger::Base</a></li>
+
+ <li><a href="MCollective/Logger/Console_logger.html#M000161">#set_logging_level — MCollective::Logger::Console_logger</a></li>
+
+ <li><a href="MCollective/Logger/Syslog_logger.html#M000177">#set_logging_level — MCollective::Logger::Syslog_logger</a></li>
+
+ <li><a href="MCollective/Logger/File_logger.html#M000181">#set_logging_level — MCollective::Logger::File_logger</a></li>
+
+ <li><a href="MCollective/RPC/ActionRunner.html#M000374">#shell — MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000414">#shellescape — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/Logger/Base.html#M000167">#should_log? — MCollective::Logger::Base</a></li>
+
+ <li><a href="MCollective/Security/Base.html#M000359">#should_process_msg? — MCollective::Security::Base</a></li>
+
+ <li><a href="MCollective/RPC/Request.html#M000398">#should_respond? — MCollective::RPC::Request</a></li>
+
+ <li><a href="MCollective/SSL.html#M000215">#sign — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/Logger/File_logger.html#M000180">#start — MCollective::Logger::File_logger</a></li>
+
+ <li><a href="MCollective/Logger/Console_logger.html#M000160">#start — MCollective::Logger::Console_logger</a></li>
+
+ <li><a href="MCollective/Logger/Base.html#M000174">#start — MCollective::Logger::Base</a></li>
+
+ <li><a href="MCollective/Logger/Syslog_logger.html#M000175">#start — MCollective::Logger::Syslog_logger</a></li>
+
+ <li><a href="MCollective/Client.html#M000509">#start_publisher — MCollective::Client</a></li>
+
+ <li><a href="MCollective/Client.html#M000510">#start_receiver — MCollective::Client</a></li>
+
+ <li><a href="String.html#M000198">#start_with? — String</a></li>
+
+ <li><a href="MCollective/Data/Base.html#M000197">#startup_hook — MCollective::Data::Base</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000416">#startup_hook — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/Client.html#M000499">#subscribe — MCollective::Client</a></li>
+
+ <li><a href="MCollective/DDL/AgentDDL.html#M000268">#summarize — MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="MCollective/Aggregate/Base.html#M000250">#summarize — MCollective::Aggregate::Base</a></li>
+
+ <li><a href="MCollective/Aggregate.html#M000139">#summarize — MCollective::Aggregate</a></li>
+
+ <li><a href="MCollective/Logger/Syslog_logger.html#M000176">#syslog_facility — MCollective::Logger::Syslog_logger</a></li>
+
+ <li><a href="MCollective/Translatable.html#M000234">#t — MCollective::Translatable</a></li>
+
+ <li><a href="MCollective/Registration/Base.html#M000157">#target_collective — MCollective::Registration::Base</a></li>
+
+ <li><a href="MCollective/RPC/ActionRunner.html#M000381">#tempfile — MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="MCollective/DDL/Base.html#M000281">#template_for_plugintype — MCollective::DDL::Base</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000438">#text_for_aggregates — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/Client.html#M000505">#threaded_req — MCollective::Client</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000434">#time_block_execution — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000427">#time_discovery — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/Discovery.html#M000150">#timeout_for_compound_filter — MCollective::Discovery</a></li>
+
+ <li><a href="MCollective/RPC/Stats.html#M000422">#to_hash — MCollective::RPC::Stats</a></li>
+
+ <li><a href="MCollective/RPC/Request.html#M000401">#to_hash — MCollective::RPC::Request</a></li>
+
+ <li><a href="MCollective/RPC/Reply.html#M000390">#to_hash — MCollective::RPC::Reply</a></li>
+
+ <li><a href="MCollective/RunnerStats.html#M000233">#to_hash — MCollective::RunnerStats</a></li>
+
+ <li><a href="MCollective/RPC/Request.html#M000403">#to_json — MCollective::RPC::Request</a></li>
+
+ <li><a href="MCollective/RPC/Result.html#M000433">#to_json — MCollective::RPC::Result</a></li>
+
+ <li><a href="MCollective/Aggregate/Result/Base.html#M000253">#to_s — MCollective::Aggregate::Result::Base</a></li>
+
+ <li><a href="MCollective/Aggregate/Result/NumericResult.html#M000256">#to_s — MCollective::Aggregate::Result::NumericResult</a></li>
+
+ <li><a href="MCollective/RPC/ActionRunner.html#M000380">#to_s — MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="MCollective/Aggregate/Result/CollectionResult.html#M000255">#to_s — MCollective::Aggregate::Result::CollectionResult</a></li>
+
+ <li><a href="MCollective/RunnerStats.html#M000226">#ttlexpired — MCollective::RunnerStats</a></li>
+
+ <li><a href="MCollective/RPC/Progress.html#M000392">#twirl — MCollective::RPC::Progress</a></li>
+
+ <li><a href="MCollective/Message.html#M000055">#type= — MCollective::Message</a></li>
+
+ <li><a href="MCollective/Client.html#M000500">#unsubscribe — MCollective::Client</a></li>
+
+ <li><a href="MCollective/Client.html#M000504">#unthreaded_req — MCollective::Client</a></li>
+
+ <li><a href="MCollective/RunnerStats.html#M000230">#unvalidated — MCollective::RunnerStats</a></li>
+
+ <li><a href="MCollective/Client.html#M000511">#update_stat — MCollective::Client</a></li>
+
+ <li><a href="MCollective/DDL/Base.html#M000280">#usage — MCollective::DDL::Base</a></li>
+
+ <li><a href="MCollective/Security/Base.html#M000360">#valid_callerid? — MCollective::Security::Base</a></li>
+
+ <li><a href="MCollective/Logger/File_logger.html#M000182">#valid_levels — MCollective::Logger::File_logger</a></li>
+
+ <li><a href="MCollective/Logger/Syslog_logger.html#M000178">#valid_levels — MCollective::Logger::Syslog_logger</a></li>
+
+ <li><a href="MCollective/Logger/Console_logger.html#M000162">#valid_levels — MCollective::Logger::Console_logger</a></li>
+
+ <li><a href="MCollective/Logger/Base.html#M000172">#valid_levels — MCollective::Logger::Base</a></li>
+
+ <li><a href="MCollective/RPC/Agent.html#M000413">#validate — MCollective::RPC::Agent</a></li>
+
+ <li><a href="MCollective/Message.html#M000066">#validate — MCollective::Message</a></li>
+
+ <li><a href="MCollective/RPC/Request.html#M000402">#validate! — MCollective::RPC::Request</a></li>
+
+ <li><a href="MCollective/Application.html#M000014">#validate_cli_options — MCollective::Application</a></li>
+
+ <li><a href="MCollective/Message.html#M000063">#validate_compound_filter — MCollective::Message</a></li>
+
+ <li><a href="MCollective/Security/Base.html#M000355">#validate_filter? — MCollective::Security::Base</a></li>
+
+ <li><a href="MCollective/DDL/Base.html#M000285">#validate_input_argument — MCollective::DDL::Base</a></li>
+
+ <li><a href="MCollective/Application.html#M000011">#validate_option — MCollective::Application</a></li>
+
+ <li><a href="MCollective/RPC/Client.html#M000449">#validate_request — MCollective::RPC::Client</a></li>
+
+ <li><a href="MCollective/DDL/Base.html#M000284">#validate_requirements — MCollective::DDL::Base</a></li>
+
+ <li><a href="MCollective/DDL/AgentDDL.html#M000275">#validate_rpc_request — MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="MCollective/RunnerStats.html#M000229">#validated — MCollective::RunnerStats</a></li>
+
+ <li><a href="MCollective/Security/Base.html#M000362">#validrequest? — MCollective::Security::Base</a></li>
+
+ <li><a href="MCollective/SSL.html#M000216">#verify_signature — MCollective::SSL</a></li>
+
+ <li><a href="MCollective/Generators/Base.html#M000241">#write_plugins — MCollective::Generators::Base</a></li>
+
+ </ul>
+
+ <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>
--- /dev/null
+<?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>File: install.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>rbconfig</li>
+
+ <li>find</li>
+
+ <li>fileutils</li>
+
+ <li>tempfile</li>
+
+ <li>optparse</li>
+
+ <li>ostruct</li>
+
+ <li>rdoc/rdoc</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+/**
+ *
+ * Darkfish Page Functions
+ * $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $
+ *
+ * Author: Michael Granger <mgranger@laika.com>
+ *
+ */
+
+/* Provide console simulation for firebug-less environments */
+if (!("console" in window) || !("firebug" in console)) {
+ var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
+ "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
+
+ window.console = {};
+ for (var i = 0; i < names.length; ++i)
+ window.console[names[i]] = function() {};
+};
+
+
+/**
+ * Unwrap the first element that matches the given @expr@ from the targets and return them.
+ */
+$.fn.unwrap = function( expr ) {
+ return this.each( function() {
+ $(this).parents( expr ).eq( 0 ).after( this ).remove();
+ });
+};
+
+
+function showSource( e ) {
+ var target = e.target;
+ var codeSections = $(target).
+ parents('.method-detail').
+ find('.method-source-code');
+
+ $(target).
+ parents('.method-detail').
+ find('.method-source-code').
+ slideToggle();
+};
+
+function hookSourceViews() {
+ $('.method-description,.method-heading').click( showSource );
+};
+
+function toggleDebuggingSection() {
+ $('.debugging-section').slideToggle();
+};
+
+function hookDebuggingToggle() {
+ $('#debugging-toggle img').click( toggleDebuggingSection );
+};
+
+function hookQuickSearch() {
+ $('.quicksearch-field').each( function() {
+ var searchElems = $(this).parents('.section').find( 'li' );
+ var toggle = $(this).parents('.section').find('h3 .search-toggle');
+ // console.debug( "Toggle is: %o", toggle );
+ var qsbox = $(this).parents('form').get( 0 );
+
+ $(this).quicksearch( this, searchElems, {
+ noSearchResultsIndicator: 'no-class-search-results',
+ focusOnLoad: false
+ });
+ $(toggle).click( function() {
+ // console.debug( "Toggling qsbox: %o", qsbox );
+ $(qsbox).toggle();
+ });
+ });
+};
+
+function highlightTarget( anchor ) {
+ console.debug( "Highlighting target '%s'.", anchor );
+
+ $("a[name=" + anchor + "]").each( function() {
+ if ( !$(this).parent().parent().hasClass('target-section') ) {
+ console.debug( "Wrapping the target-section" );
+ $('div.method-detail').unwrap( 'div.target-section' );
+ $(this).parent().wrap( '<div class="target-section"></div>' );
+ } else {
+ console.debug( "Already wrapped." );
+ }
+ });
+};
+
+function highlightLocationTarget() {
+ console.debug( "Location hash: %s", window.location.hash );
+ if ( ! window.location.hash || window.location.hash.length == 0 ) return;
+
+ var anchor = window.location.hash.substring(1);
+ console.debug( "Found anchor: %s; matching %s", anchor, "a[name=" + anchor + "]" );
+
+ highlightTarget( anchor );
+};
+
+function highlightClickTarget( event ) {
+ console.debug( "Highlighting click target for event %o", event.target );
+ try {
+ var anchor = $(event.target).attr( 'href' ).substring(1);
+ console.debug( "Found target anchor: %s", anchor );
+ highlightTarget( anchor );
+ } catch ( err ) {
+ console.error( "Exception while highlighting: %o", err );
+ };
+};
+
+
+$(document).ready( function() {
+ hookSourceViews();
+ hookDebuggingToggle();
+ hookQuickSearch();
+ highlightLocationTarget();
+
+ $('ul.link-list a').bind( "click", highlightClickTarget );
+});
--- /dev/null
+/*
+ * jQuery 1.2.6 - New Wave Javascript
+ *
+ * Copyright (c) 2008 John Resig (jquery.com)
+ * Dual licensed under the MIT (MIT-LICENSE.txt)
+ * and GPL (GPL-LICENSE.txt) licenses.
+ *
+ * $Date: 2008-09-25 09:50:52 -0700 (Thu, 25 Sep 2008) $
+ * $Rev: 38 $
+ */
+(function(){var _jQuery=window.jQuery,_$=window.$;var jQuery=window.jQuery=window.$=function(selector,context){return new jQuery.fn.init(selector,context);};var quickExpr=/^[^<]*(<(.|\s)+>)[^>]*$|^#(\w+)$/,isSimple=/^.[^:#\[\.]*$/,undefined;jQuery.fn=jQuery.prototype={init:function(selector,context){selector=selector||document;if(selector.nodeType){this[0]=selector;this.length=1;return this;}if(typeof selector=="string"){var match=quickExpr.exec(selector);if(match&&(match[1]||!context)){if(match[1])selector=jQuery.clean([match[1]],context);else{var elem=document.getElementById(match[3]);if(elem){if(elem.id!=match[3])return jQuery().find(selector);return jQuery(elem);}selector=[];}}else
+return jQuery(context).find(selector);}else if(jQuery.isFunction(selector))return jQuery(document)[jQuery.fn.ready?"ready":"load"](selector);return this.setArray(jQuery.makeArray(selector));},jquery:"1.2.6",size:function(){return this.length;},length:0,get:function(num){return num==undefined?jQuery.makeArray(this):this[num];},pushStack:function(elems){var ret=jQuery(elems);ret.prevObject=this;return ret;},setArray:function(elems){this.length=0;Array.prototype.push.apply(this,elems);return this;},each:function(callback,args){return jQuery.each(this,callback,args);},index:function(elem){var ret=-1;return jQuery.inArray(elem&&elem.jquery?elem[0]:elem,this);},attr:function(name,value,type){var options=name;if(name.constructor==String)if(value===undefined)return this[0]&&jQuery[type||"attr"](this[0],name);else{options={};options[name]=value;}return this.each(function(i){for(name in options)jQuery.attr(type?this.style:this,name,jQuery.prop(this,options[name],type,i,name));});},css:function(key,value){if((key=='width'||key=='height')&&parseFloat(value)<0)value=undefined;return this.attr(key,value,"curCSS");},text:function(text){if(typeof text!="object"&&text!=null)return this.empty().append((this[0]&&this[0].ownerDocument||document).createTextNode(text));var ret="";jQuery.each(text||this,function(){jQuery.each(this.childNodes,function(){if(this.nodeType!=8)ret+=this.nodeType!=1?this.nodeValue:jQuery.fn.text([this]);});});return ret;},wrapAll:function(html){if(this[0])jQuery(html,this[0].ownerDocument).clone().insertBefore(this[0]).map(function(){var elem=this;while(elem.firstChild)elem=elem.firstChild;return elem;}).append(this);return this;},wrapInner:function(html){return this.each(function(){jQuery(this).contents().wrapAll(html);});},wrap:function(html){return this.each(function(){jQuery(this).wrapAll(html);});},append:function(){return this.domManip(arguments,true,false,function(elem){if(this.nodeType==1)this.appendChild(elem);});},prepend:function(){return this.domManip(arguments,true,true,function(elem){if(this.nodeType==1)this.insertBefore(elem,this.firstChild);});},before:function(){return this.domManip(arguments,false,false,function(elem){this.parentNode.insertBefore(elem,this);});},after:function(){return this.domManip(arguments,false,true,function(elem){this.parentNode.insertBefore(elem,this.nextSibling);});},end:function(){return this.prevObject||jQuery([]);},find:function(selector){var elems=jQuery.map(this,function(elem){return jQuery.find(selector,elem);});return this.pushStack(/[^+>] [^+>]/.test(selector)||selector.indexOf("..")>-1?jQuery.unique(elems):elems);},clone:function(events){var ret=this.map(function(){if(jQuery.browser.msie&&!jQuery.isXMLDoc(this)){var clone=this.cloneNode(true),container=document.createElement("div");container.appendChild(clone);return jQuery.clean([container.innerHTML])[0];}else
+return this.cloneNode(true);});var clone=ret.find("*").andSelf().each(function(){if(this[expando]!=undefined)this[expando]=null;});if(events===true)this.find("*").andSelf().each(function(i){if(this.nodeType==3)return;var events=jQuery.data(this,"events");for(var type in events)for(var handler in events[type])jQuery.event.add(clone[i],type,events[type][handler],events[type][handler].data);});return ret;},filter:function(selector){return this.pushStack(jQuery.isFunction(selector)&&jQuery.grep(this,function(elem,i){return selector.call(elem,i);})||jQuery.multiFilter(selector,this));},not:function(selector){if(selector.constructor==String)if(isSimple.test(selector))return this.pushStack(jQuery.multiFilter(selector,this,true));else
+selector=jQuery.multiFilter(selector,this);var isArrayLike=selector.length&&selector[selector.length-1]!==undefined&&!selector.nodeType;return this.filter(function(){return isArrayLike?jQuery.inArray(this,selector)<0:this!=selector;});},add:function(selector){return this.pushStack(jQuery.unique(jQuery.merge(this.get(),typeof selector=='string'?jQuery(selector):jQuery.makeArray(selector))));},is:function(selector){return!!selector&&jQuery.multiFilter(selector,this).length>0;},hasClass:function(selector){return this.is("."+selector);},val:function(value){if(value==undefined){if(this.length){var elem=this[0];if(jQuery.nodeName(elem,"select")){var index=elem.selectedIndex,values=[],options=elem.options,one=elem.type=="select-one";if(index<0)return null;for(var i=one?index:0,max=one?index+1:options.length;i<max;i++){var option=options[i];if(option.selected){value=jQuery.browser.msie&&!option.attributes.value.specified?option.text:option.value;if(one)return value;values.push(value);}}return values;}else
+return(this[0].value||"").replace(/\r/g,"");}return undefined;}if(value.constructor==Number)value+='';return this.each(function(){if(this.nodeType!=1)return;if(value.constructor==Array&&/radio|checkbox/.test(this.type))this.checked=(jQuery.inArray(this.value,value)>=0||jQuery.inArray(this.name,value)>=0);else if(jQuery.nodeName(this,"select")){var values=jQuery.makeArray(value);jQuery("option",this).each(function(){this.selected=(jQuery.inArray(this.value,values)>=0||jQuery.inArray(this.text,values)>=0);});if(!values.length)this.selectedIndex=-1;}else
+this.value=value;});},html:function(value){return value==undefined?(this[0]?this[0].innerHTML:null):this.empty().append(value);},replaceWith:function(value){return this.after(value).remove();},eq:function(i){return this.slice(i,i+1);},slice:function(){return this.pushStack(Array.prototype.slice.apply(this,arguments));},map:function(callback){return this.pushStack(jQuery.map(this,function(elem,i){return callback.call(elem,i,elem);}));},andSelf:function(){return this.add(this.prevObject);},data:function(key,value){var parts=key.split(".");parts[1]=parts[1]?"."+parts[1]:"";if(value===undefined){var data=this.triggerHandler("getData"+parts[1]+"!",[parts[0]]);if(data===undefined&&this.length)data=jQuery.data(this[0],key);return data===undefined&&parts[1]?this.data(parts[0]):data;}else
+return this.trigger("setData"+parts[1]+"!",[parts[0],value]).each(function(){jQuery.data(this,key,value);});},removeData:function(key){return this.each(function(){jQuery.removeData(this,key);});},domManip:function(args,table,reverse,callback){var clone=this.length>1,elems;return this.each(function(){if(!elems){elems=jQuery.clean(args,this.ownerDocument);if(reverse)elems.reverse();}var obj=this;if(table&&jQuery.nodeName(this,"table")&&jQuery.nodeName(elems[0],"tr"))obj=this.getElementsByTagName("tbody")[0]||this.appendChild(this.ownerDocument.createElement("tbody"));var scripts=jQuery([]);jQuery.each(elems,function(){var elem=clone?jQuery(this).clone(true)[0]:this;if(jQuery.nodeName(elem,"script"))scripts=scripts.add(elem);else{if(elem.nodeType==1)scripts=scripts.add(jQuery("script",elem).remove());callback.call(obj,elem);}});scripts.each(evalScript);});}};jQuery.fn.init.prototype=jQuery.fn;function evalScript(i,elem){if(elem.src)jQuery.ajax({url:elem.src,async:false,dataType:"script"});else
+jQuery.globalEval(elem.text||elem.textContent||elem.innerHTML||"");if(elem.parentNode)elem.parentNode.removeChild(elem);}function now(){return+new Date;}jQuery.extend=jQuery.fn.extend=function(){var target=arguments[0]||{},i=1,length=arguments.length,deep=false,options;if(target.constructor==Boolean){deep=target;target=arguments[1]||{};i=2;}if(typeof target!="object"&&typeof target!="function")target={};if(length==i){target=this;--i;}for(;i<length;i++)if((options=arguments[i])!=null)for(var name in options){var src=target[name],copy=options[name];if(target===copy)continue;if(deep&©&&typeof copy=="object"&&!copy.nodeType)target[name]=jQuery.extend(deep,src||(copy.length!=null?[]:{}),copy);else if(copy!==undefined)target[name]=copy;}return target;};var expando="jQuery"+now(),uuid=0,windowData={},exclude=/z-?index|font-?weight|opacity|zoom|line-?height/i,defaultView=document.defaultView||{};jQuery.extend({noConflict:function(deep){window.$=_$;if(deep)window.jQuery=_jQuery;return jQuery;},isFunction:function(fn){return!!fn&&typeof fn!="string"&&!fn.nodeName&&fn.constructor!=Array&&/^[\s[]?function/.test(fn+"");},isXMLDoc:function(elem){return elem.documentElement&&!elem.body||elem.tagName&&elem.ownerDocument&&!elem.ownerDocument.body;},globalEval:function(data){data=jQuery.trim(data);if(data){var head=document.getElementsByTagName("head")[0]||document.documentElement,script=document.createElement("script");script.type="text/javascript";if(jQuery.browser.msie)script.text=data;else
+script.appendChild(document.createTextNode(data));head.insertBefore(script,head.firstChild);head.removeChild(script);}},nodeName:function(elem,name){return elem.nodeName&&elem.nodeName.toUpperCase()==name.toUpperCase();},cache:{},data:function(elem,name,data){elem=elem==window?windowData:elem;var id=elem[expando];if(!id)id=elem[expando]=++uuid;if(name&&!jQuery.cache[id])jQuery.cache[id]={};if(data!==undefined)jQuery.cache[id][name]=data;return name?jQuery.cache[id][name]:id;},removeData:function(elem,name){elem=elem==window?windowData:elem;var id=elem[expando];if(name){if(jQuery.cache[id]){delete jQuery.cache[id][name];name="";for(name in jQuery.cache[id])break;if(!name)jQuery.removeData(elem);}}else{try{delete elem[expando];}catch(e){if(elem.removeAttribute)elem.removeAttribute(expando);}delete jQuery.cache[id];}},each:function(object,callback,args){var name,i=0,length=object.length;if(args){if(length==undefined){for(name in object)if(callback.apply(object[name],args)===false)break;}else
+for(;i<length;)if(callback.apply(object[i++],args)===false)break;}else{if(length==undefined){for(name in object)if(callback.call(object[name],name,object[name])===false)break;}else
+for(var value=object[0];i<length&&callback.call(value,i,value)!==false;value=object[++i]){}}return object;},prop:function(elem,value,type,i,name){if(jQuery.isFunction(value))value=value.call(elem,i);return value&&value.constructor==Number&&type=="curCSS"&&!exclude.test(name)?value+"px":value;},className:{add:function(elem,classNames){jQuery.each((classNames||"").split(/\s+/),function(i,className){if(elem.nodeType==1&&!jQuery.className.has(elem.className,className))elem.className+=(elem.className?" ":"")+className;});},remove:function(elem,classNames){if(elem.nodeType==1)elem.className=classNames!=undefined?jQuery.grep(elem.className.split(/\s+/),function(className){return!jQuery.className.has(classNames,className);}).join(" "):"";},has:function(elem,className){return jQuery.inArray(className,(elem.className||elem).toString().split(/\s+/))>-1;}},swap:function(elem,options,callback){var old={};for(var name in options){old[name]=elem.style[name];elem.style[name]=options[name];}callback.call(elem);for(var name in options)elem.style[name]=old[name];},css:function(elem,name,force){if(name=="width"||name=="height"){var val,props={position:"absolute",visibility:"hidden",display:"block"},which=name=="width"?["Left","Right"]:["Top","Bottom"];function getWH(){val=name=="width"?elem.offsetWidth:elem.offsetHeight;var padding=0,border=0;jQuery.each(which,function(){padding+=parseFloat(jQuery.curCSS(elem,"padding"+this,true))||0;border+=parseFloat(jQuery.curCSS(elem,"border"+this+"Width",true))||0;});val-=Math.round(padding+border);}if(jQuery(elem).is(":visible"))getWH();else
+jQuery.swap(elem,props,getWH);return Math.max(0,val);}return jQuery.curCSS(elem,name,force);},curCSS:function(elem,name,force){var ret,style=elem.style;function color(elem){if(!jQuery.browser.safari)return false;var ret=defaultView.getComputedStyle(elem,null);return!ret||ret.getPropertyValue("color")=="";}if(name=="opacity"&&jQuery.browser.msie){ret=jQuery.attr(style,"opacity");return ret==""?"1":ret;}if(jQuery.browser.opera&&name=="display"){var save=style.outline;style.outline="0 solid black";style.outline=save;}if(name.match(/float/i))name=styleFloat;if(!force&&style&&style[name])ret=style[name];else if(defaultView.getComputedStyle){if(name.match(/float/i))name="float";name=name.replace(/([A-Z])/g,"-$1").toLowerCase();var computedStyle=defaultView.getComputedStyle(elem,null);if(computedStyle&&!color(elem))ret=computedStyle.getPropertyValue(name);else{var swap=[],stack=[],a=elem,i=0;for(;a&&color(a);a=a.parentNode)stack.unshift(a);for(;i<stack.length;i++)if(color(stack[i])){swap[i]=stack[i].style.display;stack[i].style.display="block";}ret=name=="display"&&swap[stack.length-1]!=null?"none":(computedStyle&&computedStyle.getPropertyValue(name))||"";for(i=0;i<swap.length;i++)if(swap[i]!=null)stack[i].style.display=swap[i];}if(name=="opacity"&&ret=="")ret="1";}else if(elem.currentStyle){var camelCase=name.replace(/\-(\w)/g,function(all,letter){return letter.toUpperCase();});ret=elem.currentStyle[name]||elem.currentStyle[camelCase];if(!/^\d+(px)?$/i.test(ret)&&/^\d/.test(ret)){var left=style.left,rsLeft=elem.runtimeStyle.left;elem.runtimeStyle.left=elem.currentStyle.left;style.left=ret||0;ret=style.pixelLeft+"px";style.left=left;elem.runtimeStyle.left=rsLeft;}}return ret;},clean:function(elems,context){var ret=[];context=context||document;if(typeof context.createElement=='undefined')context=context.ownerDocument||context[0]&&context[0].ownerDocument||document;jQuery.each(elems,function(i,elem){if(!elem)return;if(elem.constructor==Number)elem+='';if(typeof elem=="string"){elem=elem.replace(/(<(\w+)[^>]*?)\/>/g,function(all,front,tag){return tag.match(/^(abbr|br|col|img|input|link|meta|param|hr|area|embed)$/i)?all:front+"></"+tag+">";});var tags=jQuery.trim(elem).toLowerCase(),div=context.createElement("div");var wrap=!tags.indexOf("<opt")&&[1,"<select multiple='multiple'>","</select>"]||!tags.indexOf("<leg")&&[1,"<fieldset>","</fieldset>"]||tags.match(/^<(thead|tbody|tfoot|colg|cap)/)&&[1,"<table>","</table>"]||!tags.indexOf("<tr")&&[2,"<table><tbody>","</tbody></table>"]||(!tags.indexOf("<td")||!tags.indexOf("<th"))&&[3,"<table><tbody><tr>","</tr></tbody></table>"]||!tags.indexOf("<col")&&[2,"<table><tbody></tbody><colgroup>","</colgroup></table>"]||jQuery.browser.msie&&[1,"div<div>","</div>"]||[0,"",""];div.innerHTML=wrap[1]+elem+wrap[2];while(wrap[0]--)div=div.lastChild;if(jQuery.browser.msie){var tbody=!tags.indexOf("<table")&&tags.indexOf("<tbody")<0?div.firstChild&&div.firstChild.childNodes:wrap[1]=="<table>"&&tags.indexOf("<tbody")<0?div.childNodes:[];for(var j=tbody.length-1;j>=0;--j)if(jQuery.nodeName(tbody[j],"tbody")&&!tbody[j].childNodes.length)tbody[j].parentNode.removeChild(tbody[j]);if(/^\s/.test(elem))div.insertBefore(context.createTextNode(elem.match(/^\s*/)[0]),div.firstChild);}elem=jQuery.makeArray(div.childNodes);}if(elem.length===0&&(!jQuery.nodeName(elem,"form")&&!jQuery.nodeName(elem,"select")))return;if(elem[0]==undefined||jQuery.nodeName(elem,"form")||elem.options)ret.push(elem);else
+ret=jQuery.merge(ret,elem);});return ret;},attr:function(elem,name,value){if(!elem||elem.nodeType==3||elem.nodeType==8)return undefined;var notxml=!jQuery.isXMLDoc(elem),set=value!==undefined,msie=jQuery.browser.msie;name=notxml&&jQuery.props[name]||name;if(elem.tagName){var special=/href|src|style/.test(name);if(name=="selected"&&jQuery.browser.safari)elem.parentNode.selectedIndex;if(name in elem&¬xml&&!special){if(set){if(name=="type"&&jQuery.nodeName(elem,"input")&&elem.parentNode)throw"type property can't be changed";elem[name]=value;}if(jQuery.nodeName(elem,"form")&&elem.getAttributeNode(name))return elem.getAttributeNode(name).nodeValue;return elem[name];}if(msie&¬xml&&name=="style")return jQuery.attr(elem.style,"cssText",value);if(set)elem.setAttribute(name,""+value);var attr=msie&¬xml&&special?elem.getAttribute(name,2):elem.getAttribute(name);return attr===null?undefined:attr;}if(msie&&name=="opacity"){if(set){elem.zoom=1;elem.filter=(elem.filter||"").replace(/alpha\([^)]*\)/,"")+(parseInt(value)+''=="NaN"?"":"alpha(opacity="+value*100+")");}return elem.filter&&elem.filter.indexOf("opacity=")>=0?(parseFloat(elem.filter.match(/opacity=([^)]*)/)[1])/100)+'':"";}name=name.replace(/-([a-z])/ig,function(all,letter){return letter.toUpperCase();});if(set)elem[name]=value;return elem[name];},trim:function(text){return(text||"").replace(/^\s+|\s+$/g,"");},makeArray:function(array){var ret=[];if(array!=null){var i=array.length;if(i==null||array.split||array.setInterval||array.call)ret[0]=array;else
+while(i)ret[--i]=array[i];}return ret;},inArray:function(elem,array){for(var i=0,length=array.length;i<length;i++)if(array[i]===elem)return i;return-1;},merge:function(first,second){var i=0,elem,pos=first.length;if(jQuery.browser.msie){while(elem=second[i++])if(elem.nodeType!=8)first[pos++]=elem;}else
+while(elem=second[i++])first[pos++]=elem;return first;},unique:function(array){var ret=[],done={};try{for(var i=0,length=array.length;i<length;i++){var id=jQuery.data(array[i]);if(!done[id]){done[id]=true;ret.push(array[i]);}}}catch(e){ret=array;}return ret;},grep:function(elems,callback,inv){var ret=[];for(var i=0,length=elems.length;i<length;i++)if(!inv!=!callback(elems[i],i))ret.push(elems[i]);return ret;},map:function(elems,callback){var ret=[];for(var i=0,length=elems.length;i<length;i++){var value=callback(elems[i],i);if(value!=null)ret[ret.length]=value;}return ret.concat.apply([],ret);}});var userAgent=navigator.userAgent.toLowerCase();jQuery.browser={version:(userAgent.match(/.+(?:rv|it|ra|ie)[\/: ]([\d.]+)/)||[])[1],safari:/webkit/.test(userAgent),opera:/opera/.test(userAgent),msie:/msie/.test(userAgent)&&!/opera/.test(userAgent),mozilla:/mozilla/.test(userAgent)&&!/(compatible|webkit)/.test(userAgent)};var styleFloat=jQuery.browser.msie?"styleFloat":"cssFloat";jQuery.extend({boxModel:!jQuery.browser.msie||document.compatMode=="CSS1Compat",props:{"for":"htmlFor","class":"className","float":styleFloat,cssFloat:styleFloat,styleFloat:styleFloat,readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing"}});jQuery.each({parent:function(elem){return elem.parentNode;},parents:function(elem){return jQuery.dir(elem,"parentNode");},next:function(elem){return jQuery.nth(elem,2,"nextSibling");},prev:function(elem){return jQuery.nth(elem,2,"previousSibling");},nextAll:function(elem){return jQuery.dir(elem,"nextSibling");},prevAll:function(elem){return jQuery.dir(elem,"previousSibling");},siblings:function(elem){return jQuery.sibling(elem.parentNode.firstChild,elem);},children:function(elem){return jQuery.sibling(elem.firstChild);},contents:function(elem){return jQuery.nodeName(elem,"iframe")?elem.contentDocument||elem.contentWindow.document:jQuery.makeArray(elem.childNodes);}},function(name,fn){jQuery.fn[name]=function(selector){var ret=jQuery.map(this,fn);if(selector&&typeof selector=="string")ret=jQuery.multiFilter(selector,ret);return this.pushStack(jQuery.unique(ret));};});jQuery.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(name,original){jQuery.fn[name]=function(){var args=arguments;return this.each(function(){for(var i=0,length=args.length;i<length;i++)jQuery(args[i])[original](this);});};});jQuery.each({removeAttr:function(name){jQuery.attr(this,name,"");if(this.nodeType==1)this.removeAttribute(name);},addClass:function(classNames){jQuery.className.add(this,classNames);},removeClass:function(classNames){jQuery.className.remove(this,classNames);},toggleClass:function(classNames){jQuery.className[jQuery.className.has(this,classNames)?"remove":"add"](this,classNames);},remove:function(selector){if(!selector||jQuery.filter(selector,[this]).r.length){jQuery("*",this).add(this).each(function(){jQuery.event.remove(this);jQuery.removeData(this);});if(this.parentNode)this.parentNode.removeChild(this);}},empty:function(){jQuery(">*",this).remove();while(this.firstChild)this.removeChild(this.firstChild);}},function(name,fn){jQuery.fn[name]=function(){return this.each(fn,arguments);};});jQuery.each(["Height","Width"],function(i,name){var type=name.toLowerCase();jQuery.fn[type]=function(size){return this[0]==window?jQuery.browser.opera&&document.body["client"+name]||jQuery.browser.safari&&window["inner"+name]||document.compatMode=="CSS1Compat"&&document.documentElement["client"+name]||document.body["client"+name]:this[0]==document?Math.max(Math.max(document.body["scroll"+name],document.documentElement["scroll"+name]),Math.max(document.body["offset"+name],document.documentElement["offset"+name])):size==undefined?(this.length?jQuery.css(this[0],type):null):this.css(type,size.constructor==String?size:size+"px");};});function num(elem,prop){return elem[0]&&parseInt(jQuery.curCSS(elem[0],prop,true),10)||0;}var chars=jQuery.browser.safari&&parseInt(jQuery.browser.version)<417?"(?:[\\w*_-]|\\\\.)":"(?:[\\w\u0128-\uFFFF*_-]|\\\\.)",quickChild=new RegExp("^>\\s*("+chars+"+)"),quickID=new RegExp("^("+chars+"+)(#)("+chars+"+)"),quickClass=new RegExp("^([#.]?)("+chars+"*)");jQuery.extend({expr:{"":function(a,i,m){return m[2]=="*"||jQuery.nodeName(a,m[2]);},"#":function(a,i,m){return a.getAttribute("id")==m[2];},":":{lt:function(a,i,m){return i<m[3]-0;},gt:function(a,i,m){return i>m[3]-0;},nth:function(a,i,m){return m[3]-0==i;},eq:function(a,i,m){return m[3]-0==i;},first:function(a,i){return i==0;},last:function(a,i,m,r){return i==r.length-1;},even:function(a,i){return i%2==0;},odd:function(a,i){return i%2;},"first-child":function(a){return a.parentNode.getElementsByTagName("*")[0]==a;},"last-child":function(a){return jQuery.nth(a.parentNode.lastChild,1,"previousSibling")==a;},"only-child":function(a){return!jQuery.nth(a.parentNode.lastChild,2,"previousSibling");},parent:function(a){return a.firstChild;},empty:function(a){return!a.firstChild;},contains:function(a,i,m){return(a.textContent||a.innerText||jQuery(a).text()||"").indexOf(m[3])>=0;},visible:function(a){return"hidden"!=a.type&&jQuery.css(a,"display")!="none"&&jQuery.css(a,"visibility")!="hidden";},hidden:function(a){return"hidden"==a.type||jQuery.css(a,"display")=="none"||jQuery.css(a,"visibility")=="hidden";},enabled:function(a){return!a.disabled;},disabled:function(a){return a.disabled;},checked:function(a){return a.checked;},selected:function(a){return a.selected||jQuery.attr(a,"selected");},text:function(a){return"text"==a.type;},radio:function(a){return"radio"==a.type;},checkbox:function(a){return"checkbox"==a.type;},file:function(a){return"file"==a.type;},password:function(a){return"password"==a.type;},submit:function(a){return"submit"==a.type;},image:function(a){return"image"==a.type;},reset:function(a){return"reset"==a.type;},button:function(a){return"button"==a.type||jQuery.nodeName(a,"button");},input:function(a){return/input|select|textarea|button/i.test(a.nodeName);},has:function(a,i,m){return jQuery.find(m[3],a).length;},header:function(a){return/h\d/i.test(a.nodeName);},animated:function(a){return jQuery.grep(jQuery.timers,function(fn){return a==fn.elem;}).length;}}},parse:[/^(\[) *@?([\w-]+) *([!*$^~=]*) *('?"?)(.*?)\4 *\]/,/^(:)([\w-]+)\("?'?(.*?(\(.*?\))?[^(]*?)"?'?\)/,new RegExp("^([:.#]*)("+chars+"+)")],multiFilter:function(expr,elems,not){var old,cur=[];while(expr&&expr!=old){old=expr;var f=jQuery.filter(expr,elems,not);expr=f.t.replace(/^\s*,\s*/,"");cur=not?elems=f.r:jQuery.merge(cur,f.r);}return cur;},find:function(t,context){if(typeof t!="string")return[t];if(context&&context.nodeType!=1&&context.nodeType!=9)return[];context=context||document;var ret=[context],done=[],last,nodeName;while(t&&last!=t){var r=[];last=t;t=jQuery.trim(t);var foundToken=false,re=quickChild,m=re.exec(t);if(m){nodeName=m[1].toUpperCase();for(var i=0;ret[i];i++)for(var c=ret[i].firstChild;c;c=c.nextSibling)if(c.nodeType==1&&(nodeName=="*"||c.nodeName.toUpperCase()==nodeName))r.push(c);ret=r;t=t.replace(re,"");if(t.indexOf(" ")==0)continue;foundToken=true;}else{re=/^([>+~])\s*(\w*)/i;if((m=re.exec(t))!=null){r=[];var merge={};nodeName=m[2].toUpperCase();m=m[1];for(var j=0,rl=ret.length;j<rl;j++){var n=m=="~"||m=="+"?ret[j].nextSibling:ret[j].firstChild;for(;n;n=n.nextSibling)if(n.nodeType==1){var id=jQuery.data(n);if(m=="~"&&merge[id])break;if(!nodeName||n.nodeName.toUpperCase()==nodeName){if(m=="~")merge[id]=true;r.push(n);}if(m=="+")break;}}ret=r;t=jQuery.trim(t.replace(re,""));foundToken=true;}}if(t&&!foundToken){if(!t.indexOf(",")){if(context==ret[0])ret.shift();done=jQuery.merge(done,ret);r=ret=[context];t=" "+t.substr(1,t.length);}else{var re2=quickID;var m=re2.exec(t);if(m){m=[0,m[2],m[3],m[1]];}else{re2=quickClass;m=re2.exec(t);}m[2]=m[2].replace(/\\/g,"");var elem=ret[ret.length-1];if(m[1]=="#"&&elem&&elem.getElementById&&!jQuery.isXMLDoc(elem)){var oid=elem.getElementById(m[2]);if((jQuery.browser.msie||jQuery.browser.opera)&&oid&&typeof oid.id=="string"&&oid.id!=m[2])oid=jQuery('[@id="'+m[2]+'"]',elem)[0];ret=r=oid&&(!m[3]||jQuery.nodeName(oid,m[3]))?[oid]:[];}else{for(var i=0;ret[i];i++){var tag=m[1]=="#"&&m[3]?m[3]:m[1]!=""||m[0]==""?"*":m[2];if(tag=="*"&&ret[i].nodeName.toLowerCase()=="object")tag="param";r=jQuery.merge(r,ret[i].getElementsByTagName(tag));}if(m[1]==".")r=jQuery.classFilter(r,m[2]);if(m[1]=="#"){var tmp=[];for(var i=0;r[i];i++)if(r[i].getAttribute("id")==m[2]){tmp=[r[i]];break;}r=tmp;}ret=r;}t=t.replace(re2,"");}}if(t){var val=jQuery.filter(t,r);ret=r=val.r;t=jQuery.trim(val.t);}}if(t)ret=[];if(ret&&context==ret[0])ret.shift();done=jQuery.merge(done,ret);return done;},classFilter:function(r,m,not){m=" "+m+" ";var tmp=[];for(var i=0;r[i];i++){var pass=(" "+r[i].className+" ").indexOf(m)>=0;if(!not&&pass||not&&!pass)tmp.push(r[i]);}return tmp;},filter:function(t,r,not){var last;while(t&&t!=last){last=t;var p=jQuery.parse,m;for(var i=0;p[i];i++){m=p[i].exec(t);if(m){t=t.substring(m[0].length);m[2]=m[2].replace(/\\/g,"");break;}}if(!m)break;if(m[1]==":"&&m[2]=="not")r=isSimple.test(m[3])?jQuery.filter(m[3],r,true).r:jQuery(r).not(m[3]);else if(m[1]==".")r=jQuery.classFilter(r,m[2],not);else if(m[1]=="["){var tmp=[],type=m[3];for(var i=0,rl=r.length;i<rl;i++){var a=r[i],z=a[jQuery.props[m[2]]||m[2]];if(z==null||/href|src|selected/.test(m[2]))z=jQuery.attr(a,m[2])||'';if((type==""&&!!z||type=="="&&z==m[5]||type=="!="&&z!=m[5]||type=="^="&&z&&!z.indexOf(m[5])||type=="$="&&z.substr(z.length-m[5].length)==m[5]||(type=="*="||type=="~=")&&z.indexOf(m[5])>=0)^not)tmp.push(a);}r=tmp;}else if(m[1]==":"&&m[2]=="nth-child"){var merge={},tmp=[],test=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(m[3]=="even"&&"2n"||m[3]=="odd"&&"2n+1"||!/\D/.test(m[3])&&"0n+"+m[3]||m[3]),first=(test[1]+(test[2]||1))-0,last=test[3]-0;for(var i=0,rl=r.length;i<rl;i++){var node=r[i],parentNode=node.parentNode,id=jQuery.data(parentNode);if(!merge[id]){var c=1;for(var n=parentNode.firstChild;n;n=n.nextSibling)if(n.nodeType==1)n.nodeIndex=c++;merge[id]=true;}var add=false;if(first==0){if(node.nodeIndex==last)add=true;}else if((node.nodeIndex-last)%first==0&&(node.nodeIndex-last)/first>=0)add=true;if(add^not)tmp.push(node);}r=tmp;}else{var fn=jQuery.expr[m[1]];if(typeof fn=="object")fn=fn[m[2]];if(typeof fn=="string")fn=eval("false||function(a,i){return "+fn+";}");r=jQuery.grep(r,function(elem,i){return fn(elem,i,m,r);},not);}}return{r:r,t:t};},dir:function(elem,dir){var matched=[],cur=elem[dir];while(cur&&cur!=document){if(cur.nodeType==1)matched.push(cur);cur=cur[dir];}return matched;},nth:function(cur,result,dir,elem){result=result||1;var num=0;for(;cur;cur=cur[dir])if(cur.nodeType==1&&++num==result)break;return cur;},sibling:function(n,elem){var r=[];for(;n;n=n.nextSibling){if(n.nodeType==1&&n!=elem)r.push(n);}return r;}});jQuery.event={add:function(elem,types,handler,data){if(elem.nodeType==3||elem.nodeType==8)return;if(jQuery.browser.msie&&elem.setInterval)elem=window;if(!handler.guid)handler.guid=this.guid++;if(data!=undefined){var fn=handler;handler=this.proxy(fn,function(){return fn.apply(this,arguments);});handler.data=data;}var events=jQuery.data(elem,"events")||jQuery.data(elem,"events",{}),handle=jQuery.data(elem,"handle")||jQuery.data(elem,"handle",function(){if(typeof jQuery!="undefined"&&!jQuery.event.triggered)return jQuery.event.handle.apply(arguments.callee.elem,arguments);});handle.elem=elem;jQuery.each(types.split(/\s+/),function(index,type){var parts=type.split(".");type=parts[0];handler.type=parts[1];var handlers=events[type];if(!handlers){handlers=events[type]={};if(!jQuery.event.special[type]||jQuery.event.special[type].setup.call(elem)===false){if(elem.addEventListener)elem.addEventListener(type,handle,false);else if(elem.attachEvent)elem.attachEvent("on"+type,handle);}}handlers[handler.guid]=handler;jQuery.event.global[type]=true;});elem=null;},guid:1,global:{},remove:function(elem,types,handler){if(elem.nodeType==3||elem.nodeType==8)return;var events=jQuery.data(elem,"events"),ret,index;if(events){if(types==undefined||(typeof types=="string"&&types.charAt(0)=="."))for(var type in events)this.remove(elem,type+(types||""));else{if(types.type){handler=types.handler;types=types.type;}jQuery.each(types.split(/\s+/),function(index,type){var parts=type.split(".");type=parts[0];if(events[type]){if(handler)delete events[type][handler.guid];else
+for(handler in events[type])if(!parts[1]||events[type][handler].type==parts[1])delete events[type][handler];for(ret in events[type])break;if(!ret){if(!jQuery.event.special[type]||jQuery.event.special[type].teardown.call(elem)===false){if(elem.removeEventListener)elem.removeEventListener(type,jQuery.data(elem,"handle"),false);else if(elem.detachEvent)elem.detachEvent("on"+type,jQuery.data(elem,"handle"));}ret=null;delete events[type];}}});}for(ret in events)break;if(!ret){var handle=jQuery.data(elem,"handle");if(handle)handle.elem=null;jQuery.removeData(elem,"events");jQuery.removeData(elem,"handle");}}},trigger:function(type,data,elem,donative,extra){data=jQuery.makeArray(data);if(type.indexOf("!")>=0){type=type.slice(0,-1);var exclusive=true;}if(!elem){if(this.global[type])jQuery("*").add([window,document]).trigger(type,data);}else{if(elem.nodeType==3||elem.nodeType==8)return undefined;var val,ret,fn=jQuery.isFunction(elem[type]||null),event=!data[0]||!data[0].preventDefault;if(event){data.unshift({type:type,target:elem,preventDefault:function(){},stopPropagation:function(){},timeStamp:now()});data[0][expando]=true;}data[0].type=type;if(exclusive)data[0].exclusive=true;var handle=jQuery.data(elem,"handle");if(handle)val=handle.apply(elem,data);if((!fn||(jQuery.nodeName(elem,'a')&&type=="click"))&&elem["on"+type]&&elem["on"+type].apply(elem,data)===false)val=false;if(event)data.shift();if(extra&&jQuery.isFunction(extra)){ret=extra.apply(elem,val==null?data:data.concat(val));if(ret!==undefined)val=ret;}if(fn&&donative!==false&&val!==false&&!(jQuery.nodeName(elem,'a')&&type=="click")){this.triggered=true;try{elem[type]();}catch(e){}}this.triggered=false;}return val;},handle:function(event){var val,ret,namespace,all,handlers;event=arguments[0]=jQuery.event.fix(event||window.event);namespace=event.type.split(".");event.type=namespace[0];namespace=namespace[1];all=!namespace&&!event.exclusive;handlers=(jQuery.data(this,"events")||{})[event.type];for(var j in handlers){var handler=handlers[j];if(all||handler.type==namespace){event.handler=handler;event.data=handler.data;ret=handler.apply(this,arguments);if(val!==false)val=ret;if(ret===false){event.preventDefault();event.stopPropagation();}}}return val;},fix:function(event){if(event[expando]==true)return event;var originalEvent=event;event={originalEvent:originalEvent};var props="altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode metaKey newValue originalTarget pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target timeStamp toElement type view wheelDelta which".split(" ");for(var i=props.length;i;i--)event[props[i]]=originalEvent[props[i]];event[expando]=true;event.preventDefault=function(){if(originalEvent.preventDefault)originalEvent.preventDefault();originalEvent.returnValue=false;};event.stopPropagation=function(){if(originalEvent.stopPropagation)originalEvent.stopPropagation();originalEvent.cancelBubble=true;};event.timeStamp=event.timeStamp||now();if(!event.target)event.target=event.srcElement||document;if(event.target.nodeType==3)event.target=event.target.parentNode;if(!event.relatedTarget&&event.fromElement)event.relatedTarget=event.fromElement==event.target?event.toElement:event.fromElement;if(event.pageX==null&&event.clientX!=null){var doc=document.documentElement,body=document.body;event.pageX=event.clientX+(doc&&doc.scrollLeft||body&&body.scrollLeft||0)-(doc.clientLeft||0);event.pageY=event.clientY+(doc&&doc.scrollTop||body&&body.scrollTop||0)-(doc.clientTop||0);}if(!event.which&&((event.charCode||event.charCode===0)?event.charCode:event.keyCode))event.which=event.charCode||event.keyCode;if(!event.metaKey&&event.ctrlKey)event.metaKey=event.ctrlKey;if(!event.which&&event.button)event.which=(event.button&1?1:(event.button&2?3:(event.button&4?2:0)));return event;},proxy:function(fn,proxy){proxy.guid=fn.guid=fn.guid||proxy.guid||this.guid++;return proxy;},special:{ready:{setup:function(){bindReady();return;},teardown:function(){return;}},mouseenter:{setup:function(){if(jQuery.browser.msie)return false;jQuery(this).bind("mouseover",jQuery.event.special.mouseenter.handler);return true;},teardown:function(){if(jQuery.browser.msie)return false;jQuery(this).unbind("mouseover",jQuery.event.special.mouseenter.handler);return true;},handler:function(event){if(withinElement(event,this))return true;event.type="mouseenter";return jQuery.event.handle.apply(this,arguments);}},mouseleave:{setup:function(){if(jQuery.browser.msie)return false;jQuery(this).bind("mouseout",jQuery.event.special.mouseleave.handler);return true;},teardown:function(){if(jQuery.browser.msie)return false;jQuery(this).unbind("mouseout",jQuery.event.special.mouseleave.handler);return true;},handler:function(event){if(withinElement(event,this))return true;event.type="mouseleave";return jQuery.event.handle.apply(this,arguments);}}}};jQuery.fn.extend({bind:function(type,data,fn){return type=="unload"?this.one(type,data,fn):this.each(function(){jQuery.event.add(this,type,fn||data,fn&&data);});},one:function(type,data,fn){var one=jQuery.event.proxy(fn||data,function(event){jQuery(this).unbind(event,one);return(fn||data).apply(this,arguments);});return this.each(function(){jQuery.event.add(this,type,one,fn&&data);});},unbind:function(type,fn){return this.each(function(){jQuery.event.remove(this,type,fn);});},trigger:function(type,data,fn){return this.each(function(){jQuery.event.trigger(type,data,this,true,fn);});},triggerHandler:function(type,data,fn){return this[0]&&jQuery.event.trigger(type,data,this[0],false,fn);},toggle:function(fn){var args=arguments,i=1;while(i<args.length)jQuery.event.proxy(fn,args[i++]);return this.click(jQuery.event.proxy(fn,function(event){this.lastToggle=(this.lastToggle||0)%i;event.preventDefault();return args[this.lastToggle++].apply(this,arguments)||false;}));},hover:function(fnOver,fnOut){return this.bind('mouseenter',fnOver).bind('mouseleave',fnOut);},ready:function(fn){bindReady();if(jQuery.isReady)fn.call(document,jQuery);else
+jQuery.readyList.push(function(){return fn.call(this,jQuery);});return this;}});jQuery.extend({isReady:false,readyList:[],ready:function(){if(!jQuery.isReady){jQuery.isReady=true;if(jQuery.readyList){jQuery.each(jQuery.readyList,function(){this.call(document);});jQuery.readyList=null;}jQuery(document).triggerHandler("ready");}}});var readyBound=false;function bindReady(){if(readyBound)return;readyBound=true;if(document.addEventListener&&!jQuery.browser.opera)document.addEventListener("DOMContentLoaded",jQuery.ready,false);if(jQuery.browser.msie&&window==top)(function(){if(jQuery.isReady)return;try{document.documentElement.doScroll("left");}catch(error){setTimeout(arguments.callee,0);return;}jQuery.ready();})();if(jQuery.browser.opera)document.addEventListener("DOMContentLoaded",function(){if(jQuery.isReady)return;for(var i=0;i<document.styleSheets.length;i++)if(document.styleSheets[i].disabled){setTimeout(arguments.callee,0);return;}jQuery.ready();},false);if(jQuery.browser.safari){var numStyles;(function(){if(jQuery.isReady)return;if(document.readyState!="loaded"&&document.readyState!="complete"){setTimeout(arguments.callee,0);return;}if(numStyles===undefined)numStyles=jQuery("style, link[rel=stylesheet]").length;if(document.styleSheets.length!=numStyles){setTimeout(arguments.callee,0);return;}jQuery.ready();})();}jQuery.event.add(window,"load",jQuery.ready);}jQuery.each(("blur,focus,load,resize,scroll,unload,click,dblclick,"+"mousedown,mouseup,mousemove,mouseover,mouseout,change,select,"+"submit,keydown,keypress,keyup,error").split(","),function(i,name){jQuery.fn[name]=function(fn){return fn?this.bind(name,fn):this.trigger(name);};});var withinElement=function(event,elem){var parent=event.relatedTarget;while(parent&&parent!=elem)try{parent=parent.parentNode;}catch(error){parent=elem;}return parent==elem;};jQuery(window).bind("unload",function(){jQuery("*").add(document).unbind();});jQuery.fn.extend({_load:jQuery.fn.load,load:function(url,params,callback){if(typeof url!='string')return this._load(url);var off=url.indexOf(" ");if(off>=0){var selector=url.slice(off,url.length);url=url.slice(0,off);}callback=callback||function(){};var type="GET";if(params)if(jQuery.isFunction(params)){callback=params;params=null;}else{params=jQuery.param(params);type="POST";}var self=this;jQuery.ajax({url:url,type:type,dataType:"html",data:params,complete:function(res,status){if(status=="success"||status=="notmodified")self.html(selector?jQuery("<div/>").append(res.responseText.replace(/<script(.|\s)*?\/script>/g,"")).find(selector):res.responseText);self.each(callback,[res.responseText,status,res]);}});return this;},serialize:function(){return jQuery.param(this.serializeArray());},serializeArray:function(){return this.map(function(){return jQuery.nodeName(this,"form")?jQuery.makeArray(this.elements):this;}).filter(function(){return this.name&&!this.disabled&&(this.checked||/select|textarea/i.test(this.nodeName)||/text|hidden|password/i.test(this.type));}).map(function(i,elem){var val=jQuery(this).val();return val==null?null:val.constructor==Array?jQuery.map(val,function(val,i){return{name:elem.name,value:val};}):{name:elem.name,value:val};}).get();}});jQuery.each("ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","),function(i,o){jQuery.fn[o]=function(f){return this.bind(o,f);};});var jsc=now();jQuery.extend({get:function(url,data,callback,type){if(jQuery.isFunction(data)){callback=data;data=null;}return jQuery.ajax({type:"GET",url:url,data:data,success:callback,dataType:type});},getScript:function(url,callback){return jQuery.get(url,null,callback,"script");},getJSON:function(url,data,callback){return jQuery.get(url,data,callback,"json");},post:function(url,data,callback,type){if(jQuery.isFunction(data)){callback=data;data={};}return jQuery.ajax({type:"POST",url:url,data:data,success:callback,dataType:type});},ajaxSetup:function(settings){jQuery.extend(jQuery.ajaxSettings,settings);},ajaxSettings:{url:location.href,global:true,type:"GET",timeout:0,contentType:"application/x-www-form-urlencoded",processData:true,async:true,data:null,username:null,password:null,accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},ajax:function(s){s=jQuery.extend(true,s,jQuery.extend(true,{},jQuery.ajaxSettings,s));var jsonp,jsre=/=\?(&|$)/g,status,data,type=s.type.toUpperCase();if(s.data&&s.processData&&typeof s.data!="string")s.data=jQuery.param(s.data);if(s.dataType=="jsonp"){if(type=="GET"){if(!s.url.match(jsre))s.url+=(s.url.match(/\?/)?"&":"?")+(s.jsonp||"callback")+"=?";}else if(!s.data||!s.data.match(jsre))s.data=(s.data?s.data+"&":"")+(s.jsonp||"callback")+"=?";s.dataType="json";}if(s.dataType=="json"&&(s.data&&s.data.match(jsre)||s.url.match(jsre))){jsonp="jsonp"+jsc++;if(s.data)s.data=(s.data+"").replace(jsre,"="+jsonp+"$1");s.url=s.url.replace(jsre,"="+jsonp+"$1");s.dataType="script";window[jsonp]=function(tmp){data=tmp;success();complete();window[jsonp]=undefined;try{delete window[jsonp];}catch(e){}if(head)head.removeChild(script);};}if(s.dataType=="script"&&s.cache==null)s.cache=false;if(s.cache===false&&type=="GET"){var ts=now();var ret=s.url.replace(/(\?|&)_=.*?(&|$)/,"$1_="+ts+"$2");s.url=ret+((ret==s.url)?(s.url.match(/\?/)?"&":"?")+"_="+ts:"");}if(s.data&&type=="GET"){s.url+=(s.url.match(/\?/)?"&":"?")+s.data;s.data=null;}if(s.global&&!jQuery.active++)jQuery.event.trigger("ajaxStart");var remote=/^(?:\w+:)?\/\/([^\/?#]+)/;if(s.dataType=="script"&&type=="GET"&&remote.test(s.url)&&remote.exec(s.url)[1]!=location.host){var head=document.getElementsByTagName("head")[0];var script=document.createElement("script");script.src=s.url;if(s.scriptCharset)script.charset=s.scriptCharset;if(!jsonp){var done=false;script.onload=script.onreadystatechange=function(){if(!done&&(!this.readyState||this.readyState=="loaded"||this.readyState=="complete")){done=true;success();complete();head.removeChild(script);}};}head.appendChild(script);return undefined;}var requestDone=false;var xhr=window.ActiveXObject?new ActiveXObject("Microsoft.XMLHTTP"):new XMLHttpRequest();if(s.username)xhr.open(type,s.url,s.async,s.username,s.password);else
+xhr.open(type,s.url,s.async);try{if(s.data)xhr.setRequestHeader("Content-Type",s.contentType);if(s.ifModified)xhr.setRequestHeader("If-Modified-Since",jQuery.lastModified[s.url]||"Thu, 01 Jan 1970 00:00:00 GMT");xhr.setRequestHeader("X-Requested-With","XMLHttpRequest");xhr.setRequestHeader("Accept",s.dataType&&s.accepts[s.dataType]?s.accepts[s.dataType]+", */*":s.accepts._default);}catch(e){}if(s.beforeSend&&s.beforeSend(xhr,s)===false){s.global&&jQuery.active--;xhr.abort();return false;}if(s.global)jQuery.event.trigger("ajaxSend",[xhr,s]);var onreadystatechange=function(isTimeout){if(!requestDone&&xhr&&(xhr.readyState==4||isTimeout=="timeout")){requestDone=true;if(ival){clearInterval(ival);ival=null;}status=isTimeout=="timeout"&&"timeout"||!jQuery.httpSuccess(xhr)&&"error"||s.ifModified&&jQuery.httpNotModified(xhr,s.url)&&"notmodified"||"success";if(status=="success"){try{data=jQuery.httpData(xhr,s.dataType,s.dataFilter);}catch(e){status="parsererror";}}if(status=="success"){var modRes;try{modRes=xhr.getResponseHeader("Last-Modified");}catch(e){}if(s.ifModified&&modRes)jQuery.lastModified[s.url]=modRes;if(!jsonp)success();}else
+jQuery.handleError(s,xhr,status);complete();if(s.async)xhr=null;}};if(s.async){var ival=setInterval(onreadystatechange,13);if(s.timeout>0)setTimeout(function(){if(xhr){xhr.abort();if(!requestDone)onreadystatechange("timeout");}},s.timeout);}try{xhr.send(s.data);}catch(e){jQuery.handleError(s,xhr,null,e);}if(!s.async)onreadystatechange();function success(){if(s.success)s.success(data,status);if(s.global)jQuery.event.trigger("ajaxSuccess",[xhr,s]);}function complete(){if(s.complete)s.complete(xhr,status);if(s.global)jQuery.event.trigger("ajaxComplete",[xhr,s]);if(s.global&&!--jQuery.active)jQuery.event.trigger("ajaxStop");}return xhr;},handleError:function(s,xhr,status,e){if(s.error)s.error(xhr,status,e);if(s.global)jQuery.event.trigger("ajaxError",[xhr,s,e]);},active:0,httpSuccess:function(xhr){try{return!xhr.status&&location.protocol=="file:"||(xhr.status>=200&&xhr.status<300)||xhr.status==304||xhr.status==1223||jQuery.browser.safari&&xhr.status==undefined;}catch(e){}return false;},httpNotModified:function(xhr,url){try{var xhrRes=xhr.getResponseHeader("Last-Modified");return xhr.status==304||xhrRes==jQuery.lastModified[url]||jQuery.browser.safari&&xhr.status==undefined;}catch(e){}return false;},httpData:function(xhr,type,filter){var ct=xhr.getResponseHeader("content-type"),xml=type=="xml"||!type&&ct&&ct.indexOf("xml")>=0,data=xml?xhr.responseXML:xhr.responseText;if(xml&&data.documentElement.tagName=="parsererror")throw"parsererror";if(filter)data=filter(data,type);if(type=="script")jQuery.globalEval(data);if(type=="json")data=eval("("+data+")");return data;},param:function(a){var s=[];if(a.constructor==Array||a.jquery)jQuery.each(a,function(){s.push(encodeURIComponent(this.name)+"="+encodeURIComponent(this.value));});else
+for(var j in a)if(a[j]&&a[j].constructor==Array)jQuery.each(a[j],function(){s.push(encodeURIComponent(j)+"="+encodeURIComponent(this));});else
+s.push(encodeURIComponent(j)+"="+encodeURIComponent(jQuery.isFunction(a[j])?a[j]():a[j]));return s.join("&").replace(/%20/g,"+");}});jQuery.fn.extend({show:function(speed,callback){return speed?this.animate({height:"show",width:"show",opacity:"show"},speed,callback):this.filter(":hidden").each(function(){this.style.display=this.oldblock||"";if(jQuery.css(this,"display")=="none"){var elem=jQuery("<"+this.tagName+" />").appendTo("body");this.style.display=elem.css("display");if(this.style.display=="none")this.style.display="block";elem.remove();}}).end();},hide:function(speed,callback){return speed?this.animate({height:"hide",width:"hide",opacity:"hide"},speed,callback):this.filter(":visible").each(function(){this.oldblock=this.oldblock||jQuery.css(this,"display");this.style.display="none";}).end();},_toggle:jQuery.fn.toggle,toggle:function(fn,fn2){return jQuery.isFunction(fn)&&jQuery.isFunction(fn2)?this._toggle.apply(this,arguments):fn?this.animate({height:"toggle",width:"toggle",opacity:"toggle"},fn,fn2):this.each(function(){jQuery(this)[jQuery(this).is(":hidden")?"show":"hide"]();});},slideDown:function(speed,callback){return this.animate({height:"show"},speed,callback);},slideUp:function(speed,callback){return this.animate({height:"hide"},speed,callback);},slideToggle:function(speed,callback){return this.animate({height:"toggle"},speed,callback);},fadeIn:function(speed,callback){return this.animate({opacity:"show"},speed,callback);},fadeOut:function(speed,callback){return this.animate({opacity:"hide"},speed,callback);},fadeTo:function(speed,to,callback){return this.animate({opacity:to},speed,callback);},animate:function(prop,speed,easing,callback){var optall=jQuery.speed(speed,easing,callback);return this[optall.queue===false?"each":"queue"](function(){if(this.nodeType!=1)return false;var opt=jQuery.extend({},optall),p,hidden=jQuery(this).is(":hidden"),self=this;for(p in prop){if(prop[p]=="hide"&&hidden||prop[p]=="show"&&!hidden)return opt.complete.call(this);if(p=="height"||p=="width"){opt.display=jQuery.css(this,"display");opt.overflow=this.style.overflow;}}if(opt.overflow!=null)this.style.overflow="hidden";opt.curAnim=jQuery.extend({},prop);jQuery.each(prop,function(name,val){var e=new jQuery.fx(self,opt,name);if(/toggle|show|hide/.test(val))e[val=="toggle"?hidden?"show":"hide":val](prop);else{var parts=val.toString().match(/^([+-]=)?([\d+-.]+)(.*)$/),start=e.cur(true)||0;if(parts){var end=parseFloat(parts[2]),unit=parts[3]||"px";if(unit!="px"){self.style[name]=(end||1)+unit;start=((end||1)/e.cur(true))*start;self.style[name]=start+unit;}if(parts[1])end=((parts[1]=="-="?-1:1)*end)+start;e.custom(start,end,unit);}else
+e.custom(start,val,"");}});return true;});},queue:function(type,fn){if(jQuery.isFunction(type)||(type&&type.constructor==Array)){fn=type;type="fx";}if(!type||(typeof type=="string"&&!fn))return queue(this[0],type);return this.each(function(){if(fn.constructor==Array)queue(this,type,fn);else{queue(this,type).push(fn);if(queue(this,type).length==1)fn.call(this);}});},stop:function(clearQueue,gotoEnd){var timers=jQuery.timers;if(clearQueue)this.queue([]);this.each(function(){for(var i=timers.length-1;i>=0;i--)if(timers[i].elem==this){if(gotoEnd)timers[i](true);timers.splice(i,1);}});if(!gotoEnd)this.dequeue();return this;}});var queue=function(elem,type,array){if(elem){type=type||"fx";var q=jQuery.data(elem,type+"queue");if(!q||array)q=jQuery.data(elem,type+"queue",jQuery.makeArray(array));}return q;};jQuery.fn.dequeue=function(type){type=type||"fx";return this.each(function(){var q=queue(this,type);q.shift();if(q.length)q[0].call(this);});};jQuery.extend({speed:function(speed,easing,fn){var opt=speed&&speed.constructor==Object?speed:{complete:fn||!fn&&easing||jQuery.isFunction(speed)&&speed,duration:speed,easing:fn&&easing||easing&&easing.constructor!=Function&&easing};opt.duration=(opt.duration&&opt.duration.constructor==Number?opt.duration:jQuery.fx.speeds[opt.duration])||jQuery.fx.speeds.def;opt.old=opt.complete;opt.complete=function(){if(opt.queue!==false)jQuery(this).dequeue();if(jQuery.isFunction(opt.old))opt.old.call(this);};return opt;},easing:{linear:function(p,n,firstNum,diff){return firstNum+diff*p;},swing:function(p,n,firstNum,diff){return((-Math.cos(p*Math.PI)/2)+0.5)*diff+firstNum;}},timers:[],timerId:null,fx:function(elem,options,prop){this.options=options;this.elem=elem;this.prop=prop;if(!options.orig)options.orig={};}});jQuery.fx.prototype={update:function(){if(this.options.step)this.options.step.call(this.elem,this.now,this);(jQuery.fx.step[this.prop]||jQuery.fx.step._default)(this);if(this.prop=="height"||this.prop=="width")this.elem.style.display="block";},cur:function(force){if(this.elem[this.prop]!=null&&this.elem.style[this.prop]==null)return this.elem[this.prop];var r=parseFloat(jQuery.css(this.elem,this.prop,force));return r&&r>-10000?r:parseFloat(jQuery.curCSS(this.elem,this.prop))||0;},custom:function(from,to,unit){this.startTime=now();this.start=from;this.end=to;this.unit=unit||this.unit||"px";this.now=this.start;this.pos=this.state=0;this.update();var self=this;function t(gotoEnd){return self.step(gotoEnd);}t.elem=this.elem;jQuery.timers.push(t);if(jQuery.timerId==null){jQuery.timerId=setInterval(function(){var timers=jQuery.timers;for(var i=0;i<timers.length;i++)if(!timers[i]())timers.splice(i--,1);if(!timers.length){clearInterval(jQuery.timerId);jQuery.timerId=null;}},13);}},show:function(){this.options.orig[this.prop]=jQuery.attr(this.elem.style,this.prop);this.options.show=true;this.custom(0,this.cur());if(this.prop=="width"||this.prop=="height")this.elem.style[this.prop]="1px";jQuery(this.elem).show();},hide:function(){this.options.orig[this.prop]=jQuery.attr(this.elem.style,this.prop);this.options.hide=true;this.custom(this.cur(),0);},step:function(gotoEnd){var t=now();if(gotoEnd||t>this.options.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;var done=true;for(var i in this.options.curAnim)if(this.options.curAnim[i]!==true)done=false;if(done){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;this.elem.style.display=this.options.display;if(jQuery.css(this.elem,"display")=="none")this.elem.style.display="block";}if(this.options.hide)this.elem.style.display="none";if(this.options.hide||this.options.show)for(var p in this.options.curAnim)jQuery.attr(this.elem.style,p,this.options.orig[p]);}if(done)this.options.complete.call(this.elem);return false;}else{var n=t-this.startTime;this.state=n/this.options.duration;this.pos=jQuery.easing[this.options.easing||(jQuery.easing.swing?"swing":"linear")](this.state,n,0,1,this.options.duration);this.now=this.start+((this.end-this.start)*this.pos);this.update();}return true;}};jQuery.extend(jQuery.fx,{speeds:{slow:600,fast:200,def:400},step:{scrollLeft:function(fx){fx.elem.scrollLeft=fx.now;},scrollTop:function(fx){fx.elem.scrollTop=fx.now;},opacity:function(fx){jQuery.attr(fx.elem.style,"opacity",fx.now);},_default:function(fx){fx.elem.style[fx.prop]=fx.now+fx.unit;}}});jQuery.fn.offset=function(){var left=0,top=0,elem=this[0],results;if(elem)with(jQuery.browser){var parent=elem.parentNode,offsetChild=elem,offsetParent=elem.offsetParent,doc=elem.ownerDocument,safari2=safari&&parseInt(version)<522&&!/adobeair/i.test(userAgent),css=jQuery.curCSS,fixed=css(elem,"position")=="fixed";if(elem.getBoundingClientRect){var box=elem.getBoundingClientRect();add(box.left+Math.max(doc.documentElement.scrollLeft,doc.body.scrollLeft),box.top+Math.max(doc.documentElement.scrollTop,doc.body.scrollTop));add(-doc.documentElement.clientLeft,-doc.documentElement.clientTop);}else{add(elem.offsetLeft,elem.offsetTop);while(offsetParent){add(offsetParent.offsetLeft,offsetParent.offsetTop);if(mozilla&&!/^t(able|d|h)$/i.test(offsetParent.tagName)||safari&&!safari2)border(offsetParent);if(!fixed&&css(offsetParent,"position")=="fixed")fixed=true;offsetChild=/^body$/i.test(offsetParent.tagName)?offsetChild:offsetParent;offsetParent=offsetParent.offsetParent;}while(parent&&parent.tagName&&!/^body|html$/i.test(parent.tagName)){if(!/^inline|table.*$/i.test(css(parent,"display")))add(-parent.scrollLeft,-parent.scrollTop);if(mozilla&&css(parent,"overflow")!="visible")border(parent);parent=parent.parentNode;}if((safari2&&(fixed||css(offsetChild,"position")=="absolute"))||(mozilla&&css(offsetChild,"position")!="absolute"))add(-doc.body.offsetLeft,-doc.body.offsetTop);if(fixed)add(Math.max(doc.documentElement.scrollLeft,doc.body.scrollLeft),Math.max(doc.documentElement.scrollTop,doc.body.scrollTop));}results={top:top,left:left};}function border(elem){add(jQuery.curCSS(elem,"borderLeftWidth",true),jQuery.curCSS(elem,"borderTopWidth",true));}function add(l,t){left+=parseInt(l,10)||0;top+=parseInt(t,10)||0;}return results;};jQuery.fn.extend({position:function(){var left=0,top=0,results;if(this[0]){var offsetParent=this.offsetParent(),offset=this.offset(),parentOffset=/^body|html$/i.test(offsetParent[0].tagName)?{top:0,left:0}:offsetParent.offset();offset.top-=num(this,'marginTop');offset.left-=num(this,'marginLeft');parentOffset.top+=num(offsetParent,'borderTopWidth');parentOffset.left+=num(offsetParent,'borderLeftWidth');results={top:offset.top-parentOffset.top,left:offset.left-parentOffset.left};}return results;},offsetParent:function(){var offsetParent=this[0].offsetParent;while(offsetParent&&(!/^body|html$/i.test(offsetParent.tagName)&&jQuery.css(offsetParent,'position')=='static'))offsetParent=offsetParent.offsetParent;return jQuery(offsetParent);}});jQuery.each(['Left','Top'],function(i,name){var method='scroll'+name;jQuery.fn[method]=function(val){if(!this[0])return;return val!=undefined?this.each(function(){this==window||this==document?window.scrollTo(!i?val:jQuery(window).scrollLeft(),i?val:jQuery(window).scrollTop()):this[method]=val;}):this[0]==window||this[0]==document?self[i?'pageYOffset':'pageXOffset']||jQuery.boxModel&&document.documentElement[method]||document.body[method]:this[0][method];};});jQuery.each(["Height","Width"],function(i,name){var tl=i?"Left":"Top",br=i?"Right":"Bottom";jQuery.fn["inner"+name]=function(){return this[name.toLowerCase()]()+num(this,"padding"+tl)+num(this,"padding"+br);};jQuery.fn["outer"+name]=function(margin){return this["inner"+name]()+num(this,"border"+tl+"Width")+num(this,"border"+br+"Width")+(margin?num(this,"margin"+tl)+num(this,"margin"+br):0);};});})();
\ No newline at end of file
--- /dev/null
+/**
+ *
+ * JQuery QuickSearch - Hook up a form field to hide non-matching elements.
+ * $Id: quicksearch.js 53 2009-01-07 02:52:03Z deveiant $
+ *
+ * Author: Michael Granger <mgranger@laika.com>
+ *
+ */
+jQuery.fn.quicksearch = function( target, searchElems, options ) {
+ // console.debug( "Quicksearch fn" );
+
+ var settings = {
+ delay: 250,
+ clearButton: false,
+ highlightMatches: false,
+ focusOnLoad: false,
+ noSearchResultsIndicator: null
+ };
+ if ( options ) $.extend( settings, options );
+
+ return jQuery(this).each( function() {
+ // console.debug( "Creating a new quicksearch on %o for %o", this, searchElems );
+ new jQuery.quicksearch( this, searchElems, settings );
+ });
+};
+
+
+jQuery.quicksearch = function( searchBox, searchElems, settings ) {
+ var timeout;
+ var boxdiv = $(searchBox).parents('div').eq(0);
+
+ function init() {
+ setupKeyEventHandlers();
+ focusOnLoad();
+ };
+
+ function setupKeyEventHandlers() {
+ // console.debug( "Hooking up the 'keypress' event to %o", searchBox );
+ $(searchBox).
+ unbind( 'keyup' ).
+ keyup( function(e) { return onSearchKey( e.keyCode ); });
+ $(searchBox).
+ unbind( 'keypress' ).
+ keypress( function(e) {
+ switch( e.which ) {
+ // Execute the search on Enter, Tab, or Newline
+ case 9:
+ case 13:
+ case 10:
+ clearTimeout( timeout );
+ e.preventDefault();
+ doQuickSearch();
+ break;
+
+ // Allow backspace
+ case 8:
+ return true;
+ break;
+
+ // Only allow valid search characters
+ default:
+ return validQSChar( e.charCode );
+ }
+ });
+ };
+
+ function focusOnLoad() {
+ if ( !settings.focusOnLoad ) return false;
+ $(searchBox).focus();
+ };
+
+ function onSearchKey ( code ) {
+ clearTimeout( timeout );
+ // console.debug( "...scheduling search." );
+ timeout = setTimeout( doQuickSearch, settings.delay );
+ };
+
+ function validQSChar( code ) {
+ var c = String.fromCharCode( code );
+ return (
+ (c == ':') ||
+ (c >= 'a' && c <= 'z') ||
+ (c >= 'A' && c <= 'Z')
+ );
+ };
+
+ function doQuickSearch() {
+ var searchText = searchBox.value;
+ var pat = new RegExp( searchText, "im" );
+ var shownCount = 0;
+
+ if ( settings.noSearchResultsIndicator ) {
+ $('#' + settings.noSearchResultsIndicator).hide();
+ }
+
+ // All elements start out hidden
+ $(searchElems).each( function(index) {
+ var str = $(this).text();
+
+ if ( pat.test(str) ) {
+ shownCount += 1;
+ $(this).fadeIn();
+ } else {
+ $(this).hide();
+ }
+ });
+
+ if ( shownCount == 0 && settings.noSearchResultsIndicator ) {
+ $('#' + settings.noSearchResultsIndicator).slideDown();
+ }
+ };
+
+ init();
+};
--- /dev/null
+/*
+ * Thickbox 3 - One Box To Rule Them All.
+ * By Cody Lindley (http://www.codylindley.com)
+ * Copyright (c) 2007 cody lindley
+ * Licensed under the MIT License: http://www.opensource.org/licenses/mit-license.php
+*/
+
+var tb_pathToImage = "../images/loadingAnimation.gif";
+
+eval(function(p,a,c,k,e,r){e=function(c){return(c<a?'':e(parseInt(c/a)))+((c=c%a)>35?String.fromCharCode(c+29):c.toString(36))};if(!''.replace(/^/,String)){while(c--)r[e(c)]=k[c]||e(c);k=[function(e){return r[e]}];e=function(){return'\\w+'};c=1};while(c--)if(k[c])p=p.replace(new RegExp('\\b'+e(c)+'\\b','g'),k[c]);return p}('$(o).2S(9(){1u(\'a.18, 3n.18, 3i.18\');1w=1p 1t();1w.L=2H});9 1u(b){$(b).s(9(){6 t=X.Q||X.1v||M;6 a=X.u||X.23;6 g=X.1N||P;19(t,a,g);X.2E();H P})}9 19(d,f,g){3m{3(2t o.v.J.2i==="2g"){$("v","11").r({A:"28%",z:"28%"});$("11").r("22","2Z");3(o.1Y("1F")===M){$("v").q("<U 5=\'1F\'></U><4 5=\'B\'></4><4 5=\'8\'></4>");$("#B").s(G)}}n{3(o.1Y("B")===M){$("v").q("<4 5=\'B\'></4><4 5=\'8\'></4>");$("#B").s(G)}}3(1K()){$("#B").1J("2B")}n{$("#B").1J("2z")}3(d===M){d=""}$("v").q("<4 5=\'K\'><1I L=\'"+1w.L+"\' /></4>");$(\'#K\').2y();6 h;3(f.O("?")!==-1){h=f.3l(0,f.O("?"))}n{h=f}6 i=/\\.2s$|\\.2q$|\\.2m$|\\.2l$|\\.2k$/;6 j=h.1C().2h(i);3(j==\'.2s\'||j==\'.2q\'||j==\'.2m\'||j==\'.2l\'||j==\'.2k\'){1D="";1G="";14="";1z="";1x="";R="";1n="";1r=P;3(g){E=$("a[@1N="+g+"]").36();25(D=0;((D<E.1c)&&(R===""));D++){6 k=E[D].u.1C().2h(i);3(!(E[D].u==f)){3(1r){1z=E[D].Q;1x=E[D].u;R="<1e 5=\'1X\'>&1d;&1d;<a u=\'#\'>2T &2R;</a></1e>"}n{1D=E[D].Q;1G=E[D].u;14="<1e 5=\'1U\'>&1d;&1d;<a u=\'#\'>&2O; 2N</a></1e>"}}n{1r=1b;1n="1t "+(D+1)+" 2L "+(E.1c)}}}S=1p 1t();S.1g=9(){S.1g=M;6 a=2x();6 x=a[0]-1M;6 y=a[1]-1M;6 b=S.z;6 c=S.A;3(b>x){c=c*(x/b);b=x;3(c>y){b=b*(y/c);c=y}}n 3(c>y){b=b*(y/c);c=y;3(b>x){c=c*(x/b);b=x}}13=b+30;1a=c+2G;$("#8").q("<a u=\'\' 5=\'1L\' Q=\'1o\'><1I 5=\'2F\' L=\'"+f+"\' z=\'"+b+"\' A=\'"+c+"\' 23=\'"+d+"\'/></a>"+"<4 5=\'2D\'>"+d+"<4 5=\'2C\'>"+1n+14+R+"</4></4><4 5=\'2A\'><a u=\'#\' 5=\'Z\' Q=\'1o\'>1l</a> 1k 1j 1s</4>");$("#Z").s(G);3(!(14==="")){9 12(){3($(o).N("s",12)){$(o).N("s",12)}$("#8").C();$("v").q("<4 5=\'8\'></4>");19(1D,1G,g);H P}$("#1U").s(12)}3(!(R==="")){9 1i(){$("#8").C();$("v").q("<4 5=\'8\'></4>");19(1z,1x,g);H P}$("#1X").s(1i)}o.1h=9(e){3(e==M){I=2w.2v}n{I=e.2u}3(I==27){G()}n 3(I==3k){3(!(R=="")){o.1h="";1i()}}n 3(I==3j){3(!(14=="")){o.1h="";12()}}};16();$("#K").C();$("#1L").s(G);$("#8").r({Y:"T"})};S.L=f}n{6 l=f.2r(/^[^\\?]+\\??/,\'\');6 m=2p(l);13=(m[\'z\']*1)+30||3h;1a=(m[\'A\']*1)+3g||3f;W=13-30;V=1a-3e;3(f.O(\'2j\')!=-1){1E=f.1B(\'3d\');$("#15").C();3(m[\'1A\']!="1b"){$("#8").q("<4 5=\'2f\'><4 5=\'1H\'>"+d+"</4><4 5=\'2e\'><a u=\'#\' 5=\'Z\' Q=\'1o\'>1l</a> 1k 1j 1s</4></4><U 1W=\'0\' 2d=\'0\' L=\'"+1E[0]+"\' 5=\'15\' 1v=\'15"+1f.2c(1f.1y()*2b)+"\' 1g=\'1m()\' J=\'z:"+(W+29)+"p;A:"+(V+17)+"p;\' > </U>")}n{$("#B").N();$("#8").q("<U 1W=\'0\' 2d=\'0\' L=\'"+1E[0]+"\' 5=\'15\' 1v=\'15"+1f.2c(1f.1y()*2b)+"\' 1g=\'1m()\' J=\'z:"+(W+29)+"p;A:"+(V+17)+"p;\'> </U>")}}n{3($("#8").r("Y")!="T"){3(m[\'1A\']!="1b"){$("#8").q("<4 5=\'2f\'><4 5=\'1H\'>"+d+"</4><4 5=\'2e\'><a u=\'#\' 5=\'Z\'>1l</a> 1k 1j 1s</4></4><4 5=\'F\' J=\'z:"+W+"p;A:"+V+"p\'></4>")}n{$("#B").N();$("#8").q("<4 5=\'F\' 3c=\'3b\' J=\'z:"+W+"p;A:"+V+"p;\'></4>")}}n{$("#F")[0].J.z=W+"p";$("#F")[0].J.A=V+"p";$("#F")[0].3a=0;$("#1H").11(d)}}$("#Z").s(G);3(f.O(\'37\')!=-1){$("#F").q($(\'#\'+m[\'26\']).1T());$("#8").24(9(){$(\'#\'+m[\'26\']).q($("#F").1T())});16();$("#K").C();$("#8").r({Y:"T"})}n 3(f.O(\'2j\')!=-1){16();3($.1q.35){$("#K").C();$("#8").r({Y:"T"})}}n{$("#F").34(f+="&1y="+(1p 33().32()),9(){16();$("#K").C();1u("#F a.18");$("#8").r({Y:"T"})})}}3(!m[\'1A\']){o.21=9(e){3(e==M){I=2w.2v}n{I=e.2u}3(I==27){G()}}}}31(e){}}9 1m(){$("#K").C();$("#8").r({Y:"T"})}9 G(){$("#2Y").N("s");$("#Z").N("s");$("#8").2X("2W",9(){$(\'#8,#B,#1F\').2V("24").N().C()});$("#K").C();3(2t o.v.J.2i=="2g"){$("v","11").r({A:"1Z",z:"1Z"});$("11").r("22","")}o.1h="";o.21="";H P}9 16(){$("#8").r({2U:\'-\'+20((13/2),10)+\'p\',z:13+\'p\'});3(!(1V.1q.2Q&&1V.1q.2P<7)){$("#8").r({38:\'-\'+20((1a/2),10)+\'p\'})}}9 2p(a){6 b={};3(!a){H b}6 c=a.1B(/[;&]/);25(6 i=0;i<c.1c;i++){6 d=c[i].1B(\'=\');3(!d||d.1c!=2){39}6 e=2a(d[0]);6 f=2a(d[1]);f=f.2r(/\\+/g,\' \');b[e]=f}H b}9 2x(){6 a=o.2M;6 w=1S.2o||1R.2o||(a&&a.1Q)||o.v.1Q;6 h=1S.1P||1R.1P||(a&&a.2n)||o.v.2n;1O=[w,h];H 1O}9 1K(){6 a=2K.2J.1C();3(a.O(\'2I\')!=-1&&a.O(\'3o\')!=-1){H 1b}}',62,211,'|||if|div|id|var||TB_window|function||||||||||||||else|document|px|append|css|click||href|body||||width|height|TB_overlay|remove|TB_Counter|TB_TempArray|TB_ajaxContent|tb_remove|return|keycode|style|TB_load|src|null|unbind|indexOf|false|title|TB_NextHTML|imgPreloader|block|iframe|ajaxContentH|ajaxContentW|this|display|TB_closeWindowButton||html|goPrev|TB_WIDTH|TB_PrevHTML|TB_iframeContent|tb_position||thickbox|tb_show|TB_HEIGHT|true|length|nbsp|span|Math|onload|onkeydown|goNext|Esc|or|close|tb_showIframe|TB_imageCount|Close|new|browser|TB_FoundURL|Key|Image|tb_init|name|imgLoader|TB_NextURL|random|TB_NextCaption|modal|split|toLowerCase|TB_PrevCaption|urlNoQuery|TB_HideSelect|TB_PrevURL|TB_ajaxWindowTitle|img|addClass|tb_detectMacXFF|TB_ImageOff|150|rel|arrayPageSize|innerHeight|clientWidth|self|window|children|TB_prev|jQuery|frameborder|TB_next|getElementById|auto|parseInt|onkeyup|overflow|alt|unload|for|inlineId||100||unescape|1000|round|hspace|TB_closeAjaxWindow|TB_title|undefined|match|maxHeight|TB_iframe|bmp|gif|png|clientHeight|innerWidth|tb_parseQuery|jpeg|replace|jpg|typeof|which|keyCode|event|tb_getPageSize|show|TB_overlayBG|TB_closeWindow|TB_overlayMacFFBGHack|TB_secondLine|TB_caption|blur|TB_Image|60|tb_pathToImage|mac|userAgent|navigator|of|documentElement|Prev|lt|version|msie|gt|ready|Next|marginLeft|trigger|fast|fadeOut|TB_imageOff|hidden||catch|getTime|Date|load|safari|get|TB_inline|marginTop|continue|scrollTop|TB_modal|class|TB_|45|440|40|630|input|188|190|substr|try|area|firefox'.split('|'),0,{}))
\ No newline at end of file
--- /dev/null
+<?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>File: agent.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: agents.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: base.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: base.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: collection_result.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: numeric_result.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: result.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: aggregate.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: application.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: applications.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: cache.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: client.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: config.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: base.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: connector.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: base.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: result.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: data.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: agentddl.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: base.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: dataddl.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: discoveryddl.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: validatorddl.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: ddl.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: discovery.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: exception.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: base.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: facts.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: agent_generator.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: base.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: data_generator.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: action_snippet.erb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+# Example Input input :name,
+</p>
+<pre>
+ :prompt => "%PROMPT%",
+ :description => "%DESCRIPTION%",
+ :type => %TYPE%,
+ :validation => '%VALIDATION%',
+ :optional => %OPTIONAL%,
+ :maxlength => %MAXLENGTH%
+</pre>
+<p>
+# Example output output :name,
+</p>
+<pre>
+ :description => "%DESCRIPTION%",
+ :display_as => "%DISPLAYAS%"
+</pre>
+
+ </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>
+
--- /dev/null
+<?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>File: data_input_snippet.erb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+input :query,
+</p>
+<pre>
+ :prompt => "%PROMP%",
+ :description => "%DESCRIPTION%",
+ :type => %TYPE%,
+ :validation => %VALIDATION%,
+ :maxlength => %MAXLENGTH%
+</pre>
+
+ </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>
+
--- /dev/null
+<?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>File: ddl.erb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+metadata :name => “<%= meta[:name] || “%FULLNANE%”
+-%>”,
+</p>
+<pre>
+ :description => "<%= meta[:description] || "%DESCRIPTION%" -%>",
+ :author => "<%= meta[:author] || "%AUTHOR%" -%>",
+ :license => "<%= meta[:license] || "%LICENSE%" -%>",
+ :version => "<%= meta[:version] || "%VERSION%" -%>",
+ :url => "<%= meta[:url] || "%URL%" -%>",
+ :timeout => <%= meta[:timeout] || "%TIMEOUT%" %>
+</pre>
+
+ </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>
+
--- /dev/null
+<?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>File: plugin.erb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+module <a href="../../../../MCollective.html">MCollective</a>
+</p>
+<pre>
+ module <%= @mod_name%>
+ class <%= @plugin_name.capitalize -%><<%= @pclass%>
+</pre>
+<p>
+<%= @content%>
+</p>
+<pre>
+ end
+ end
+</pre>
+<p>
+end
+</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>
+
--- /dev/null
+<?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>File: generators.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: en.yml [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+en:
+</p>
+<pre>
+ PLMC1:
+ example: "The Marionette Collective version 2.2.2 started by /usr/bin/mco using config file /etc/mcollective/client.cfg"
+ expanded: "This message gets logged each time MCollective reads it's config file. Generally this only happens once per process. It shows the version, process name and config file as a simple debugging aid"
+ pattern: "The Marionette Collective version %{version} started by %{name} using config file %{config}"
+ PLMC10:
+ example: "Failed to handle message: RuntimeError: none.rb:15:in `decodemsg': Could not decrypt message "
+ expanded: |-
+ When a message arrives from the middleware it gets decoded, security validated and then dispatched to the agent code.
+
+ There exist a number of errors that can happen here, some are handled specifically others will be logged by this "catch all" handler.
+
+ Generally there should not be many messages logged here but we include a stack trace to assist with debugging these.
+
+ The messages here do not tend to originate from your Agents unless they are syntax error related but more likely to be situations like security failures due to incorrect SSL keys and so forth
+
+ Should you come across one that is a regular accorance in your logs please open a ticket including your backtrace and we will improve the handling of that situation
+ pattern: "Failed to handle message: %{error}"
+ PLMC11:
+ example: "Cache expired on 'ddl' key 'agent/nrpe'"
+ expanded: |-
+ MCollective has an internal Cache used to speed up operations like parsing of DDL files. The cache is also usable from the agents and other plugins you write.
+
+ Each entry in the cache has an associated TTL or maximum life time, once the maximum time on an item is reached it is considered expired. Next time anything attempts to read this entry from the cache this log line will be logged.
+
+ This is part of the normal operations of MCollective and doesn't indicate any problem. We log this debug message to help you debug your own use of the cache.
+ pattern: "Cache expired on '%{cache_name}' key '%{item}'"
+ PLMC12:
+ example: "Cache hit on 'ddl' key 'agent/nrpe'"
+ expanded: |-
+ MCollective has an internal Cache used to speed up operations like parsing of DDL files. The cache is also usable from the agents and other plugins you write.
+
+ Each entry in the cache has an associated TTL or maximum life time, once the maximum time on an item is reached it is considered expired.
+
+ This log line indicates that a request for a cache entry was made, the entry had not yet expired and so the cached data is being returned.
+
+ It does not indicate a problem, it's just a debugging aid
+ pattern: "Cache hit on '%{cache_name}' key '%{item}'"
+ PLMC13:
+ example: "Could not find a cache called 'my_cache'"
+ expanded: |-
+ MCollective has an internal Cache used to speed up operations like parsing of DDL files. The cache is also usable from the agents and other plugins you write.
+
+ The cache is made up of many named caches, this error indicates that a cache has not yet been setup prior to trying to use it.
+ pattern: "Could not find a cache called '%{cache_name}'"
+ PLMC14:
+ example: "No block supplied to synchronize on cache 'my_cache'"
+ expanded: |-
+ When using the Cache to synchronize your own code across agents or other plugins you have to supply a block to synchronise.
+
+ Correct usage would be:
+
+ Cache.setup(:customer, 600)
+ Cache(:customer).synchronize do
+ # update customer record
+ end
+
+ This error is raise when the logic to update the customer record is not in a block as in the example
+ pattern: "No block supplied to synchronize on cache '%{cache_name}'"
+ PLMC15:
+ example: "No item called 'nrpe_agent' for cache 'ddl'"
+ expanded: |-
+ MCollective has an internal Cache used to speed up operations like parsing of DDL files. The cache is also usable from the agents and other plugins you write.
+
+ The cache stored items using a key, this error will be logged and raised when you try to access a item that does not yet exist in the cache.
+ pattern: "No item called '%{item}' for cache '%{cache_name}'"
+ PLMC16:
+ example: "'hello' does not look like a numeric value"
+ expanded: |-
+ When MCollective receives an argument from the command line like port=fello it consults the DDL file to determine the desired type of this parameter, it then tries to convert the input string into the correct numeric value.
+
+ This error indicates the input you provided could not be converted into the desired format.
+
+ You'll usually see this when using the 'mco rpc' command to interact with an agent. This is usually a fatal error, the request will not be sent if it does not validate against the DDL.
+ pattern: "'%{value}' does not look like a numeric value"
+ PLMC17:
+ example: "'flase' does not look like a boolean value"
+ expanded: |-
+ When MCollective receives an argument from the command line like force=true it consults the DDL file to determine the desired type of this parameter, it then tries to convert the input string into the correct boolean value.
+
+ This error indicates the input you provided could not be converted into the desired boolean format. It wil accept "true", "t", "yes", "y" and "1" as being true. It will accept "false", "f", "no", "n", "0" as being false.
+
+ You'll usually see this when using the 'mco rpc' command to interact with an agent. This is usually a fatal error, the request will not be sent if it does not validate against the DDL.
+ pattern: "'%{value}' does not look like a boolean value"
+ PLMC18:
+ example: "Found 'rpcutil' ddl at '/usr/libexec/mcollective/mcollective/agent/rpcutil.ddl'"
+ expanded: |-
+ Most plugin types have a DDL file that needs to be correctly installed for the plugin to function. There can be multiple libdirs that can provide the DDL file for a specific plugin.
+
+ This message is a message designed to help you debug issues when you think the wrong DDL file is being used.
+ pattern: "Found '%{ddlname}' ddl at '%{ddlfile}'"
+ PLMC19:
+ expanded: |-
+ Usually when MCollective run it validates all requirements are met before publishing a request or processing a request against the DDL file for the agent.
+
+ This can be difficult to satisfy in development perhaps because you are still writing your DDL files or debugging issues.
+
+ This message indicates that when MCollective detects it's running against an unreleased version of MCollective - like directly out of a Git clone - it will skip the DDL validation steps. It is logged at a warning level as this significantly changes the behaviour of the client and server.
+ pattern: "DDL requirements validation being skipped in development"
+ PLMC2:
+ expanded: "When sending the mcollectived process the USR1 signal on a Unix based machine this message will indicate that the signal got received and all agents are being reloaded from disk\n"
+ pattern: "Reloading all agents after receiving USR1 signal"
+ PLMC20:
+ example: "Agent plugin 'example' requires MCollective version 2.2.1 or newer"
+ expanded: |-
+ MCollective plugins can declare a minimum version of MCollective that they require to be functional.
+
+ MCollective validates this when it loads the plugin and this error will be logged or shown to the user when this requirement cannot be satisfied.
+ pattern: "%{type} plugin '%{name}' requires MCollective version %{requirement} or newer"
+ PLMC21:
+ example: "Cannot validate input 'service': Input string is longer than 40 character(s)"
+ expanded: |-
+ Every input you provide to a RPC request is validated against it's DDL file. This error will be shown when the supplied data does not pass validation against the DDL.
+
+ Consult the 'mco plugin doc' command to view the DDL file for your action and input.
+ pattern: "Cannot validate input '%{input}: %{error}"
+ PLMC22:
+ example: "Cannot determine what entity input 'port' belongs to"
+ expanded: |-
+ When writing a DDL you declare inputs into plugins using the input keyword. Each input has to belong to a wrapping entity like in the example below:
+
+ action "get_data", :description => "Get data from a data plugin" do
+ input :source,
+ :prompt => "Data Source",
+ :description => "The data plugin to retrieve information from",
+ :type => :string,
+ :validation => '^\w+$',
+ :optional => false,
+ :maxlength => 50
+ end
+
+ Here the input belongs to the action entity "get_data", this error indicates that an input were found without it belonging to any specific entity
+ pattern: "Cannot determine what entity input '%{input}' belongs to"
+ PLMC23:
+ example: "Input needs a :prompt property"
+ expanded: "When writing a DDL you declare inputs for all data that you pass into the plugin. Inputs have a minimally required field set and this error indicate that you did not provide some key field while describing the input."
+ pattern: "Input needs a :%{property} property"
+ PLMC24:
+ example: "Failed to load DDL for the 'rpcutil' agent, DDLs are required: RuntimeError: failed to parse DDL file"
+ expanded: |-
+ As of version 2.0.0 DDL files are required by the MCollective server. This server indicates that it either could not find the DDL for the rpcutil agent or that there was a syntax error.
+
+ Confirm that the DDL file is installed in the agent directory and that it parses correctly using the 'mco plugin doc' command.
+ pattern: "Failed to load DDL for the '%{agent}' agent, DDLs are required: %{error_class}: %{error}"
+ PLMC25:
+ example: "aggregate method for action 'rpcutil' is missing a function parameter"
+ expanded: |-
+ DDL files can declare aggregation rules for the data returned by actions as seen below:
+
+ summarize do
+ aggregate summary(:collectives)
+ end
+
+ This error indicates that you did not supply the argument - :collectives in this example.
+ pattern: "aggregate method for action '%{action}' is missing a function parameter"
+ PLMC26:
+ expanded: |-
+ Internally when MCollective parse the DDL it converts the aggregate functions into a hash with the function name and any arguments.
+
+ This error indicates that the internal translation failed, this is a critical error and would probably indicate a structure problem in your DDL or a bug in MCollective
+ pattern: "Functions supplied to aggregate should be a hash"
+ PLMC27:
+ expanded: |-
+ DDL aggregate functions can take a custom format as in the example below:
+
+ aggregate average(:total_resources, :format => "Average: %d")
+
+ This error indicate that the :format above could not be correctly parsed.
+ pattern: "Formats supplied to aggregation functions must have a :format key"
+ PLMC28:
+ expanded: |-
+ DDL aggregate functions can take a custom format as in the example below:
+
+ aggregate average(:total_resources, :format => "Average: %d")
+
+ This error indicate that the :format above was not supplied as a hash as in the above example
+ pattern: "Formats supplied to aggregation functions should be a hash"
+ PLMC29:
+ example: "Attempted to call action 'yum_clean' for 'package' but it's not declared in the DDL"
+ expanded: |-
+ Every agent has a DDL file that describes valid actions that they can perform
+
+ This error indicates you attempted to perform an action that does not exist. Review the plugin documentation using 'mco plugin doc' for correct usage
+ pattern: "Attempted to call action '%{action}' for '%{plugin}' but it's not declared in the DDL"
+ PLMC3:
+ expanded: |-
+ When sending the mcollectived process the USR2 signal on a Unix based machine this message indicates that the signal for received and the logging level is being adjusted to the next higher level or back down to debug if it was already at it's highest level.
+
+ This message will be followed by another message similar to the one below:
+
+ Logging level is now WARN
+ pattern: "Cycling logging level due to USR2 signal"
+ PLMC30:
+ example: "Action 'get_fact' needs a 'fact' argument"
+ expanded: "Actions can declare that they expect a required input, this error indicates that you did not supply the required input"
+ pattern: "Action '%{action}' needs a '%{key}' argument"
+ PLMC31:
+ example: "No dataquery has been defined in the DDL for data plugin 'package'"
+ expanded: |-
+ Each data plugin requires a DDL that has a 'dataquery' block in it.
+
+ dataquery :description => "Agent Meta Data" do
+ .
+ .
+ end
+
+ This error indicates that the DDL file for a specific data plugin did not contain this block.
+ pattern: "No dataquery has been defined in the DDL for data plugin '%{plugin}'"
+ PLMC32:
+ expanded: "Data plugins must return data. The DDL files for a data plugin must declare at least one output parameter else you will see this error."
+ pattern: "No output has been defined in the DDL for data plugin '%{plugin}'"
+ PLMC33:
+ example: "No data plugin argument was declared in the 'puppet' DDL but an input was supplied"
+ expanded: |-
+ Data plugins can take an optional input argument. This error indicate that you supplied an input argument but the plugin does not actually expect any input.
+
+ Review the documentation for the data plugin using 'mco plugin doc'
+ pattern: "No data plugin argument was declared in the '%{plugin}' DDL but an input was supplied"
+ PLMC34:
+ example: "setting meta data in agents have been deprecated, DDL files are now being used for this information. Please update the 'package' agent"
+ expanded: |-
+ In the past each MCollective agent had a metadata section containing information like the timeout.
+
+ As of 2.2.0 the agents will now consult the DDL files that ship with each agent for this purpose so the metadata in agents are not used at all.
+
+ In order to remove confusing duplication setting metadata in agents have been deprecated and from version 2.4.0 will not be supported at all.
+
+ Please update your agent by removing the metadata section from it and make sure the DDL file has the correct information instead.
+ pattern: "setting meta data in agents have been deprecated, DDL files are now being used for this information. Please update the '%{agent}' agent"
+ PLMC35:
+ expanded: |-
+ The MCollective client can ask that the agent just performs the action and never respond. Like when supplying the --no-results option to the 'mco rpc' application.
+
+ This log line indicates that the request was received and interpreted as such and no reply will be sent. This does not indicate a problem generally it's just there to assist with debugging of problems.
+ pattern: "Client did not request a response, surpressing reply"
+ PLMC36:
+ example: "Unknown action 'png' for agent 'rpcutil'"
+ expanded: |-
+ Agents are made up of a number of named actions. When the MCollective Server receives a request it double checks if the agent in question actually implements the logic for a specific action.
+
+ When it cannot find the implementation this error will be raised. This is an unusual situation since at this point on both the client and the server the DDL will already have been used to validate the request and the DDL would have indicated that the action is valid.
+
+ Check your agent code and make sure you have code like:
+
+ action "the_action" do
+ .
+ .
+ end
+ pattern: "Unknown action '%{action}' for agent '%{agent}'"
+ PLMC37:
+ example: "Starting default activation checks for the 'rpcutil' agent"
+ expanded: |-
+ Each time the MCollective daemon starts it loads each agent from disk. It then tries to determine if the agent should start on this node by using the activate_when method or per-agent configuration.
+
+ This is a debug statement that shows you it is about to start interacting with the logic in the agent to determine if it should be made available or not.
+ pattern: "Starting default activation checks for the '%{agent}' agent"
+ PLMC38:
+ example: "Found plugin configuration 'exim.activate_agent' with value 'y'"
+ expanded: |-
+ The administrator can choose that a certain agent that is deployed on this machine should not be made available to the network.
+
+ To do this you would add a configuration value like this example to the mcollective server.cfg:
+
+ plugin.exim.activate_agent = n
+
+ If this value is "1", "y" or "true" the agent will be activated else it will be disabled.
+ pattern: "Found plugin configuration '%{agent}.activate_agent' with value '%{should_activate}'"
+ PLMC39:
+ example: "Audit failed with an error, processing the request will continue."
+ expanded: |-
+ Every MCollective request can be audited. In the event where the auditing fails the processing continues.
+
+ At present the failure handling is not configurable, in future the administrator might elect to not run unaudited requests via configuration.
+ PLMC4:
+ example: "Failed to start registration plugin: ArgumentError: meta.rb:6:in `gsub': wrong number of arguments (0 for 2)"
+ expanded: |
+ Registration plugins are loaded into the MCollective daemon at startup and ran on a regular interval.
+
+ This message indicate that on first start this plugin failed to run, it will show the exception class, line and exception message to assist with debugging
+ pattern: "Failed to start registration plugin: %{error}"
+ PLMC40:
+ example: "Can't find DDL for agent plugin 'puppet'"
+ expanded: |-
+ MCollective plugins come with DDL files that describe their behaviours, versions, capabilities and requirements.
+
+ This error indicate that a DDL file for the plugin mentioned could not be found - it could be that you have a typing error in your command line or an installation error.
+ pattern: "Can't find DDL for %{type} plugin '%{name}'"
+ PLMC41:
+ example: "Data plugin 'agent()' function does not return a 'foo' value"
+ expanded: |-
+ Data functions return a set of values which can be identified by name.
+
+ This message indicates that the specified value has not been defined in the Data plugin's DDL.
+ pattern: "Data plugin '%{functionname}()' does not return a '%{value}' value"
+ PLMC42:
+ example: "Cannot convert string value 'hello' into a boolean. "
+ expanded: |-
+ This error gets logged when there is an attempt to convert a string value into a boolean, but the string does not match the boolean pattern.
+
+ Strings that match "1", "y", "yes", "YES", "t", "true" and "TRUE" will be transformed into a boolean true.
+
+ Strings that match "0", "n", "no", "NO", "f", "false" and "FALSE" will be transformed into a boolean false.
+ pattern: "Cannot convert string value '%{value}' into a boolean. "
+ PLMC5:
+ expanded: |-
+ In previous versions of MCollective a application called 'controller' were included that had the ability to request agent reloads and other commands that would control the runner.
+
+ Unfortunately this method of controlling the daemon was never considered stable or reliable and has since been deprecate for removal during the 2.3.x development series
+ pattern: "Received a control message, possibly via 'mco controller' but this has been deprecated"
+ PLMC6:
+ expanded: |-
+ When a specific MCollective daemon receives a message from a network it validates the filter before processing the message. The filter is the list of classes, facts or other conditions that are associated with any message.
+
+ In the case where the filter does not match the specific host this line gets logged.
+
+ It's often the case for broadcast messages that all MCollective nodes will receive a message but only a subset of nodes are targetted using the filters, in that situation the nodes that received the request but should not respond to it will see this log line.
+
+ It does not indicate anything to be concerned about but if you find debugging a problem and expect a node to have responded when it shouldn't this log line will give you a hint that some condition specified in the filter did not match the local host
+ pattern: "Message does not pass filters, ignoring"
+ PLMC7:
+ example: "Exiting after signal: SignalException: runner.rb:6:in `run': Interrupt"
+ expanded: |-
+ When the MCollective daemon gets a signal from the Operating System that it does not specifically handle it will log this line before exiting.
+
+ You would see this whenever the daemon is stopped by init script or when sending it a kill signal, it will then proceed to disconnect from the middleware and exit its main loop
+ pattern: "Exiting after signal: %{error}"
+ PLMC8:
+ example: "Handling message for agent 'rpcutil' on collective 'eu_collective' with requestid 'a8a78d0ff555c931f045b6f448129846'"
+ expanded: |-
+ After receiving a message from the middleware, decoding it, validating it's security credentials and doing other checks on it the MCollective daemon will pass it off to the actual agent code for processing.
+
+ Prior to doing so it will log this line indicating the agent name and sub-collective and other information that will assist in correlating the message sent from the client with those in the server logs being processed.
+ pattern: "Handling message for agent '%{agent}' on collective '%{collective} with requestid '%{requestid}'"
+ PLMC9:
+ example: "Expired Message: message 8b4fe522f0d0541dabe83ec10b7fa446 from cert=client@node created at 1358840888 is 653 seconds old, TTL is 60"
+ expanded: |-
+ Requests sent from clients to servers all have a creation time and a maximum validity time called a TTL.
+
+ This message indicates that a message was received from the network but that it was determined to be too based on the TTL settings.
+
+ Usually this happens because your clocks are not in sync - something that can be fixed by rolling out a tool like ntp across your server estate.
+
+ It might also happen during very slow network conditions or when the TTL is set too low for your general network latency.
+ pattern: "Expired Message: %{error}"
+</pre>
+
+ </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>
+
--- /dev/null
+<?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>File: log.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>mcollective/logger/%s_logger</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: base.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: console_logger.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: file_logger.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>logger</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: syslog_logger.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>syslog</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: logger.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: parser.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: scanner.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: matcher.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: message.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: monkey_patches.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>enumerator</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+ <p>
+start_with? was introduced in 1.8.7, we need to support 1.8.5 and 1.8.6
+</p>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: optionparser.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: pluginmanager.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: agent_definition.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: standard_definition.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: pluginpackager.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: base.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: registration.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: actionrunner.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: agent.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: audit.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: client.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: helpers.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: progress.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: reply.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: request.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: result.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: stats.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: rpc.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>pp</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: runner.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: runnerstats.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: base.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: security.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: shell.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: ssl.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>openssl</li>
+
+ <li>base64</li>
+
+ <li>digest/sha1</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: translatable.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: unix_daemon.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: util.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>win32/dir</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: validator.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: windows_daemon.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>win32/daemon</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: mcollective.rb [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+
+ <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="file file-popup">
+ <div id="metadata">
+ <dl>
+ <dt class="modified-date">Last Modified</dt>
+ <dd class="modified-date">Fri Nov 15 12:17:20 +0000 2013</dd>
+
+
+ <dt class="requires">Requires</dt>
+ <dd class="requires">
+ <ul>
+
+ <li>rubygems</li>
+
+ <li>stomp</li>
+
+ <li>timeout</li>
+
+ <li>digest/md5</li>
+
+ <li>optparse</li>
+
+ <li>singleton</li>
+
+ <li>socket</li>
+
+ <li>erb</li>
+
+ <li>shellwords</li>
+
+ <li>stringio</li>
+
+ <li>rbconfig</li>
+
+ <li>tempfile</li>
+
+ <li>tmpdir</li>
+
+ <li>mcollective/exception</li>
+
+ <li>mcollective/monkey_patches</li>
+
+ <li>mcollective/translatable</li>
+
+ <li>mcollective/cache</li>
+
+ </ul>
+ </dd>
+
+
+
+ </dl>
+ </div>
+
+ <div id="documentation">
+
+ <div class="description">
+ <h2>Description</h2>
+
+ </div>
+
+ </div>
+</body>
+</html>
+
--- /dev/null
+<?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>File: mcollective.init [mcollective version 2.3.3]</title>
+
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+
+ <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="file">
+ <div id="metadata">
+ <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">
+ <p>
+#!/bin/sh # # mcollective Application Server for STOMP based agents # #
+chkconfig: 345 24 76 # # description: mcollective lets you build powerful
+Stomp compatible middleware clients in ruby without having to worry too #
+much about all the setup and management of a Stomp connection, it also
+provides stats, logging and so forth # as a bonus. # ### BEGIN INIT INFO #
+Provides: mcollective # Required-Start: $remote_fs # Required-Stop:
+$remote_fs # Default-Start: 2 3 4 5 # Default-Stop: 0 1 6 #
+Short-Description: Start daemon at boot time # Description: Enable service
+provided by daemon. ### END INIT INFO
+</p>
+<p>
+mcollectived=“/usr/sbin/mcollectived“
+</p>
+<p>
+# Lockfile if [ -d /var/lock/subsys ]; then
+</p>
+<pre>
+ # RedHat/CentOS/etc who use subsys
+ lock="/var/lock/subsys/mcollective"
+</pre>
+<p>
+else
+</p>
+<pre>
+ # The rest of them
+ lock="/var/lock/mcollective"
+</pre>
+<p>
+fi
+</p>
+<p>
+# PID directory pidfile=“/var/run/mcollectived.pid“
+</p>
+<p>
+# Source function library. . /lib/lsb/init-functions
+</p>
+<p>
+# Check that binary exists if ! [ -f $mcollectived ] then
+</p>
+<pre>
+ echo "mcollectived binary not found"
+ exit 0
+</pre>
+<p>
+fi
+</p>
+<p>
+# See how we were called. case “$1” in
+</p>
+<pre>
+ start)
+ echo -n "Starting mcollective: "
+
+ if [ -f ${lock} ]; then
+ # we were not shut down correctly
+ if [ -s ${pidfile} ]; then
+ kill `cat ${pidfile}` >/dev/null 2>&1
+ fi
+ rm -f ${pidfile}
+
+ rm -f ${lock}
+ sleep 2
+ fi
+
+ rm -f ${pidfile}
+
+ ${mcollectived} --pid=${pidfile} --config="/etc/mcollective/server.cfg"
+ if [ $? = 0 ]; then
+ log_success_msg
+ touch $lock
+ exit 0
+ else
+ log_failure_msg
+ exit 1
+ fi
+ ;;
+ stop)
+ echo -n "Shutting down mcollective: "
+
+ if [ -s ${pidfile} ]; then
+ kill `cat ${pidfile}` >/dev/null 2>&1
+ fi
+ rm -f ${pidfile}
+
+ log_success_msg
+ rm -f $lock
+ ;;
+ restart)
+ $0 stop
+ sleep 2
+ $0 start
+ ;;
+ condrestart)
+ if [ -f $lock ]; then
+ $0 stop
+ # avoid race
+ sleep 2
+ $0 start
+ fi
+ ;;
+ status)
+ if [ -f ${lock} ]; then
+ if [ -s ${pidfile} ]; then
+ if [ -e /proc/`cat ${pidfile}` ]; then
+ echo "mcollectived (`cat ${pidfile}`) is running"
+ exit 0
+ else
+ echo "mcollectived (`cat ${pidfile}`) is NOT running"
+ exit 1
+ fi
+ fi
+ else
+ echo "mcollectived: service not started"
+ exit 1
+ fi
+ ;;
+ force-reload)
+ echo "not implemented"
+ ;;
+ *)
+ echo "Usage: mcollectived {start|stop|restart|condrestart|status}"
+ exit 1
+ ;;
+</pre>
+<p>
+esac exit 0
+</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>
+
+++ /dev/null
-
-body {
- font-family: Verdana,Arial,Helvetica,sans-serif;
- font-size: 90%;
- margin: 0;
- margin-left: 40px;
- padding: 0;
- background: white;
-}
-
-h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
-h1 { font-size: 150%; }
-h2,h3,h4 { margin-top: 1em; }
-
-a { background: #eef; color: #039; text-decoration: none; }
-a:hover { background: #039; color: #eef; }
-
-/* Override the base stylesheet's Anchor inside a table cell */
-td > a {
- background: transparent;
- color: #039;
- text-decoration: none;
-}
-
-/* and inside a section title */
-.section-title > a {
- background: transparent;
- color: #eee;
- text-decoration: none;
-}
-
-/* === Structural elements =================================== */
-
-div#index {
- margin: 0;
- margin-left: -40px;
- padding: 0;
- font-size: 90%;
-}
-
-
-div#index a {
- margin-left: 0.7em;
-}
-
-div#index .section-bar {
- margin-left: 0px;
- padding-left: 0.7em;
- background: #ccc;
- font-size: small;
-}
-
-
-div#classHeader, div#fileHeader {
- width: auto;
- color: white;
- padding: 0.5em 1.5em 0.5em 1.5em;
- margin: 0;
- margin-left: -40px;
- border-bottom: 3px solid #006;
-}
-
-div#classHeader a, div#fileHeader a {
- background: inherit;
- color: white;
-}
-
-div#classHeader td, div#fileHeader td {
- background: inherit;
- color: white;
-}
-
-
-div#fileHeader {
- background: #057;
-}
-
-div#classHeader {
- background: #048;
-}
-
-
-.class-name-in-header {
- font-size: 180%;
- font-weight: bold;
-}
-
-
-div#bodyContent {
- padding: 0 1.5em 0 1.5em;
-}
-
-div#description {
- padding: 0.5em 1.5em;
- background: #efefef;
- border: 1px dotted #999;
-}
-
-div#description h1,h2,h3,h4,h5,h6 {
- color: #125;;
- background: transparent;
-}
-
-div#validator-badges {
- text-align: center;
-}
-div#validator-badges img { border: 0; }
-
-div#copyright {
- color: #333;
- background: #efefef;
- font: 0.75em sans-serif;
- margin-top: 5em;
- margin-bottom: 0;
- padding: 0.5em 2em;
-}
-
-
-/* === Classes =================================== */
-
-table.header-table {
- color: white;
- font-size: small;
-}
-
-.type-note {
- font-size: small;
- color: #DEDEDE;
-}
-
-.xxsection-bar {
- background: #eee;
- color: #333;
- padding: 3px;
-}
-
-.section-bar {
- color: #333;
- border-bottom: 1px solid #999;
- margin-left: -20px;
-}
-
-
-.section-title {
- background: #79a;
- color: #eee;
- padding: 3px;
- margin-top: 2em;
- margin-left: -30px;
- border: 1px solid #999;
-}
-
-.top-aligned-row { vertical-align: top }
-.bottom-aligned-row { vertical-align: bottom }
-
-/* --- Context section classes ----------------------- */
-
-.context-row { }
-.context-item-name { font-family: monospace; font-weight: bold; color: black; }
-.context-item-value { font-size: small; color: #448; }
-.context-item-desc { color: #333; padding-left: 2em; }
-
-/* --- Method classes -------------------------- */
-.method-detail {
- background: #efefef;
- padding: 0;
- margin-top: 0.5em;
- margin-bottom: 1em;
- border: 1px dotted #ccc;
-}
-.method-heading {
- color: black;
- background: #ccc;
- border-bottom: 1px solid #666;
- padding: 0.2em 0.5em 0 0.5em;
-}
-.method-signature { color: black; background: inherit; }
-.method-name { font-weight: bold; }
-.method-args { font-style: italic; }
-.method-description { padding: 0 0.5em 0 0.5em; }
-
-/* --- Source code sections -------------------- */
-
-a.source-toggle { font-size: 90%; }
-div.method-source-code {
- background: #262626;
- color: #ffdead;
- margin: 1em;
- padding: 0.5em;
- border: 1px dashed #999;
- overflow: hidden;
-}
-
-div.method-source-code pre { color: #ffdead; overflow: hidden; }
-
-/* --- Ruby keyword styles --------------------- */
-
-.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
-
-.ruby-constant { color: #7fffd4; background: transparent; }
-.ruby-keyword { color: #00ffff; background: transparent; }
-.ruby-ivar { color: #eedd82; background: transparent; }
-.ruby-operator { color: #00ffee; background: transparent; }
-.ruby-identifier { color: #ffdead; background: transparent; }
-.ruby-node { color: #ffa07a; background: transparent; }
-.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
-.ruby-regexp { color: #ffa07a; background: transparent; }
-.ruby-value { color: #7fffd4; background: transparent; }
\ No newline at end of file
--- /dev/null
+/*
+ * "Darkfish" Rdoc CSS
+ * $Id: rdoc.css 54 2009-01-27 01:09:48Z deveiant $
+ *
+ * Author: Michael Granger <ged@FaerieMUD.org>
+ *
+ */
+
+/* Base Green is: #6C8C22 */
+
+*{ padding: 0; margin: 0; }
+
+body {
+ background: #efefef;
+ font: 14px "Helvetica Neue", Helvetica, Tahoma, sans-serif;
+}
+body.class, body.module, body.file {
+ margin-left: 40px;
+}
+body.file-popup {
+ font-size: 90%;
+ margin-left: 0;
+}
+
+h1 {
+ font-size: 300%;
+ text-shadow: rgba(135,145,135,0.65) 2px 2px 3px;
+ color: #6C8C22;
+}
+h2,h3,h4 { margin-top: 1.5em; }
+
+a {
+ color: #6C8C22;
+ text-decoration: none;
+}
+a:hover {
+ border-bottom: 1px dotted #6C8C22;
+}
+
+pre {
+ background: #ddd;
+ padding: 0.5em 0;
+}
+
+
+/* @group Generic Classes */
+
+.initially-hidden {
+ display: none;
+}
+
+.quicksearch-field {
+ width: 98%;
+ background: #ddd;
+ border: 1px solid #aaa;
+ height: 1.5em;
+ -webkit-border-radius: 4px;
+}
+.quicksearch-field:focus {
+ background: #f1edba;
+}
+
+.missing-docs {
+ font-size: 120%;
+ background: white url(images/wrench_orange.png) no-repeat 4px center;
+ color: #ccc;
+ line-height: 2em;
+ border: 1px solid #d00;
+ opacity: 1;
+ padding-left: 20px;
+ text-indent: 24px;
+ letter-spacing: 3px;
+ font-weight: bold;
+ -webkit-border-radius: 5px;
+ -moz-border-radius: 5px;
+}
+
+.target-section {
+ border: 2px solid #dcce90;
+ border-left-width: 8px;
+ padding: 0 1em;
+ background: #fff3c2;
+}
+
+/* @end */
+
+
+/* @group Index Page, Standalone file pages */
+body.indexpage {
+ margin: 1em 3em;
+}
+body.indexpage p,
+body.indexpage div,
+body.file p {
+ margin: 1em 0;
+}
+
+.indexpage ul,
+.file #documentation ul {
+ line-height: 160%;
+ list-style: none;
+}
+.indexpage ul a,
+.file #documentation ul a {
+ font-size: 16px;
+}
+
+.indexpage li,
+.file #documentation li {
+ padding-left: 20px;
+ background: url(images/bullet_black.png) no-repeat left 4px;
+}
+.indexpage li.module {
+ background: url(images/package.png) no-repeat left 4px;
+}
+.indexpage li.class {
+ background: url(images/ruby.png) no-repeat left 4px;
+}
+.indexpage li.file {
+ background: url(images/page_white_text.png) no-repeat left 4px;
+}
+
+/* @end */
+
+/* @group Top-Level Structure */
+
+.class #metadata,
+.file #metadata,
+.module #metadata {
+ float: left;
+ width: 260px;
+}
+
+.class #documentation,
+.file #documentation,
+.module #documentation {
+ margin: 2em 1em 5em 300px;
+ min-width: 340px;
+}
+
+.file #metadata {
+ margin: 0.8em;
+}
+
+#validator-badges {
+ clear: both;
+ margin: 1em 1em 2em;
+}
+
+/* @end */
+
+/* @group Metadata Section */
+#metadata .section {
+ background-color: #dedede;
+ -moz-border-radius: 5px;
+ -webkit-border-radius: 5px;
+ border: 1px solid #aaa;
+ margin: 0 8px 16px;
+ font-size: 90%;
+ overflow: hidden;
+}
+#metadata h3.section-header {
+ margin: 0;
+ padding: 2px 8px;
+ background: #ccc;
+ color: #666;
+ -moz-border-radius-topleft: 4px;
+ -moz-border-radius-topright: 4px;
+ -webkit-border-top-left-radius: 4px;
+ -webkit-border-top-right-radius: 4px;
+ border-bottom: 1px solid #aaa;
+}
+#metadata ul,
+#metadata dl,
+#metadata p {
+ padding: 8px;
+ list-style: none;
+}
+
+#file-metadata ul {
+ padding-left: 28px;
+ list-style-image: url(images/page_green.png);
+}
+
+dl.svninfo {
+ color: #666;
+ margin: 0;
+}
+dl.svninfo dt {
+ font-weight: bold;
+}
+
+ul.link-list li {
+ white-space: nowrap;
+}
+ul.link-list .type {
+ font-size: 8px;
+ text-transform: uppercase;
+ color: white;
+ background: #969696;
+ padding: 2px 4px;
+ -webkit-border-radius: 5px;
+}
+
+/* @end */
+
+
+/* @group Project Metadata Section */
+#project-metadata {
+ margin-top: 3em;
+}
+
+.file #project-metadata {
+ margin-top: 0em;
+}
+
+#project-metadata .section {
+ border: 1px solid #aaa;
+}
+#project-metadata h3.section-header {
+ border-bottom: 1px solid #aaa;
+ position: relative;
+}
+#project-metadata h3.section-header .search-toggle {
+ position: absolute;
+ right: 5px;
+}
+
+
+#project-metadata form {
+ color: #777;
+ background: #ccc;
+ padding: 8px 8px 16px;
+ border-bottom: 1px solid #bbb;
+}
+#project-metadata fieldset {
+ border: 0;
+}
+
+#no-class-search-results {
+ margin: 0 auto 1em;
+ text-align: center;
+ font-size: 14px;
+ font-weight: bold;
+ color: #aaa;
+}
+
+/* @end */
+
+
+/* @group Documentation Section */
+#description {
+ font-size: 100%;
+ color: #333;
+}
+
+#description p {
+ margin: 1em 0.4em;
+}
+
+#description ul {
+ margin-left: 2em;
+}
+#description ul li {
+ line-height: 1.4em;
+}
+
+#description dl,
+#documentation dl {
+ margin: 8px 1.5em;
+ border: 1px solid #ccc;
+}
+#description dl {
+ font-size: 14px;
+}
+
+#description dt,
+#documentation dt {
+ padding: 2px 4px;
+ font-weight: bold;
+ background: #ddd;
+}
+#description dd,
+#documentation dd {
+ padding: 2px 12px;
+}
+#description dd + dt,
+#documentation dd + dt {
+ margin-top: 0.7em;
+}
+
+#documentation .section {
+ font-size: 90%;
+}
+#documentation h3.section-header {
+ margin-top: 2em;
+ padding: 0.75em 0.5em;
+ background-color: #dedede;
+ color: #333;
+ font-size: 150%;
+ border: 1px solid #bbb;
+ -moz-border-radius: 3px;
+ -webkit-border-radius: 3px;
+}
+
+#constants-list > dl,
+#attributes-list > dl {
+ margin: 1em 0 2em;
+ border: 0;
+}
+#constants-list > dl dt,
+#attributes-list > dl dt {
+ padding-left: 0;
+ font-weight: bold;
+ font-family: Monaco, "Andale Mono";
+ background: inherit;
+}
+#constants-list > dl dt a,
+#attributes-list > dl dt a {
+ color: inherit;
+}
+#constants-list > dl dd,
+#attributes-list > dl dd {
+ margin: 0 0 1em 0;
+ padding: 0;
+ color: #666;
+}
+
+/* @group Method Details */
+
+#documentation .method-source-code {
+ display: none;
+}
+
+#documentation .method-detail {
+ margin: 0.5em 0;
+ padding: 0.5em 0;
+ cursor: pointer;
+}
+#documentation .method-detail:hover {
+ background-color: #f1edba;
+}
+#documentation .method-alias {
+ font-style: oblique;
+}
+#documentation .method-heading {
+ position: relative;
+ padding: 2px 4px 0 20px;
+ font-size: 125%;
+ font-weight: bold;
+ color: #333;
+ background: url(images/brick.png) no-repeat left bottom;
+}
+#documentation .method-heading a {
+ color: inherit;
+}
+#documentation .method-click-advice {
+ position: absolute;
+ top: 2px;
+ right: 5px;
+ font-size: 10px;
+ color: #9b9877;
+ visibility: hidden;
+ padding-right: 20px;
+ line-height: 20px;
+ background: url(images/zoom.png) no-repeat right top;
+}
+#documentation .method-detail:hover .method-click-advice {
+ visibility: visible;
+}
+
+#documentation .method-alias .method-heading {
+ color: #666;
+ background: url(images/brick_link.png) no-repeat left bottom;
+}
+
+#documentation .method-description,
+#documentation .aliases {
+ margin: 0 20px;
+ line-height: 1.2em;
+ color: #666;
+}
+#documentation .aliases {
+ padding-top: 4px;
+ font-style: italic;
+ cursor: default;
+}
+#documentation .method-description p {
+ padding: 0;
+}
+#documentation .method-description p + p {
+ margin-bottom: 0.5em;
+}
+
+#documentation .attribute-method-heading {
+ background: url(images/tag_green.png) no-repeat left bottom;
+}
+#documentation #attribute-method-details .method-detail:hover {
+ background-color: transparent;
+ cursor: default;
+}
+#documentation .attribute-access-type {
+ font-size: 60%;
+ text-transform: uppercase;
+ vertical-align: super;
+ padding: 0 2px;
+}
+/* @end */
+
+/* @end */
+
+
+
+/* @group Source Code */
+
+a.source-toggle {
+ font-size: 90%;
+}
+a.source-toggle img {
+
+}
+
+div.method-source-code {
+ background: #262626;
+ color: #efefef;
+ margin: 1em;
+ padding: 0.5em;
+ border: 1px dashed #999;
+ overflow: hidden;
+}
+
+div.method-source-code pre {
+ background: inherit;
+ padding: 0;
+ color: white;
+ overflow: hidden;
+}
+
+/* @group Ruby keyword styles */
+
+.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
+
+.ruby-constant { color: #7fffd4; background: transparent; }
+.ruby-keyword { color: #00ffff; background: transparent; }
+.ruby-ivar { color: #eedd82; background: transparent; }
+.ruby-operator { color: #00ffee; background: transparent; }
+.ruby-identifier { color: #ffdead; background: transparent; }
+.ruby-node { color: #ffa07a; background: transparent; }
+.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
+.ruby-regexp { color: #ffa07a; background: transparent; }
+.ruby-value { color: #7fffd4; background: transparent; }
+
+/* @end */
+/* @end */
+
+
+/* @group File Popup Contents */
+
+.file #metadata,
+.file-popup #metadata {
+}
+
+.file-popup dl {
+ font-size: 80%;
+ padding: 0.75em;
+ background-color: #dedede;
+ color: #333;
+ border: 1px solid #bbb;
+ -moz-border-radius: 3px;
+ -webkit-border-radius: 3px;
+}
+.file dt {
+ font-weight: bold;
+ padding-left: 22px;
+ line-height: 20px;
+ background: url(images/page_white_width.png) no-repeat left top;
+}
+.file dt.modified-date {
+ background: url(images/date.png) no-repeat left top;
+}
+.file dt.requires {
+ background: url(images/plugin.png) no-repeat left top;
+}
+.file dt.scs-url {
+ background: url(images/wrench.png) no-repeat left top;
+}
+
+.file dl dd {
+ margin: 0 0 1em 0;
+}
+.file #metadata dl dd ul {
+ list-style: circle;
+ margin-left: 20px;
+ padding-top: 0;
+}
+.file #metadata dl dd ul li {
+}
+
+
+.file h2 {
+ margin-top: 2em;
+ padding: 0.75em 0.5em;
+ background-color: #dedede;
+ color: #333;
+ font-size: 120%;
+ border: 1px solid #bbb;
+ -moz-border-radius: 3px;
+ -webkit-border-radius: 3px;
+}
+
+/* @end */
+
+
+
+
+/* @group ThickBox Styles */
+#TB_window {
+ font: 12px Arial, Helvetica, sans-serif;
+ color: #333333;
+}
+
+#TB_secondLine {
+ font: 10px Arial, Helvetica, sans-serif;
+ color:#666666;
+}
+
+#TB_window a:link {color: #666666;}
+#TB_window a:visited {color: #666666;}
+#TB_window a:hover {color: #000;}
+#TB_window a:active {color: #666666;}
+#TB_window a:focus{color: #666666;}
+
+#TB_overlay {
+ position: fixed;
+ z-index:100;
+ top: 0px;
+ left: 0px;
+ height:100%;
+ width:100%;
+}
+
+.TB_overlayMacFFBGHack {background: url(images/macFFBgHack.png) repeat;}
+.TB_overlayBG {
+ background-color:#000;
+ filter:alpha(opacity=75);
+ -moz-opacity: 0.75;
+ opacity: 0.75;
+}
+
+* html #TB_overlay { /* ie6 hack */
+ position: absolute;
+ height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
+}
+
+#TB_window {
+ position: fixed;
+ background: #ffffff;
+ z-index: 102;
+ color:#000000;
+ display:none;
+ border: 4px solid #525252;
+ text-align:left;
+ top:50%;
+ left:50%;
+}
+
+* html #TB_window { /* ie6 hack */
+position: absolute;
+margin-top: expression(0 - parseInt(this.offsetHeight / 2) + (TBWindowMargin = document.documentElement && document.documentElement.scrollTop || document.body.scrollTop) + 'px');
+}
+
+#TB_window img#TB_Image {
+ display:block;
+ margin: 15px 0 0 15px;
+ border-right: 1px solid #ccc;
+ border-bottom: 1px solid #ccc;
+ border-top: 1px solid #666;
+ border-left: 1px solid #666;
+}
+
+#TB_caption{
+ height:25px;
+ padding:7px 30px 10px 25px;
+ float:left;
+}
+
+#TB_closeWindow{
+ height:25px;
+ padding:11px 25px 10px 0;
+ float:right;
+}
+
+#TB_closeAjaxWindow{
+ padding:7px 10px 5px 0;
+ margin-bottom:1px;
+ text-align:right;
+ float:right;
+}
+
+#TB_ajaxWindowTitle{
+ float:left;
+ padding:7px 0 5px 10px;
+ margin-bottom:1px;
+ font-size: 22px;
+}
+
+#TB_title{
+ background-color: #6C8C22;
+ color: #dedede;
+ height:40px;
+}
+#TB_title a {
+ color: white !important;
+ border-bottom: 1px dotted #dedede;
+}
+
+#TB_ajaxContent{
+ clear:both;
+ padding:2px 15px 15px 15px;
+ overflow:auto;
+ text-align:left;
+ line-height:1.4em;
+}
+
+#TB_ajaxContent.TB_modal{
+ padding:15px;
+}
+
+#TB_ajaxContent p{
+ padding:5px 0px 5px 0px;
+}
+
+#TB_load{
+ position: fixed;
+ display:none;
+ height:13px;
+ width:208px;
+ z-index:103;
+ top: 50%;
+ left: 50%;
+ margin: -6px 0 0 -104px; /* -height/2 0 0 -width/2 */
+}
+
+* html #TB_load { /* ie6 hack */
+position: absolute;
+margin-top: expression(0 - parseInt(this.offsetHeight / 2) + (TBWindowMargin = document.documentElement && document.documentElement.scrollTop || document.body.scrollTop) + 'px');
+}
+
+#TB_HideSelect{
+ z-index:99;
+ position:fixed;
+ top: 0;
+ left: 0;
+ background-color:#fff;
+ border:none;
+ filter:alpha(opacity=0);
+ -moz-opacity: 0;
+ opacity: 0;
+ height:100%;
+ width:100%;
+}
+
+* html #TB_HideSelect { /* ie6 hack */
+ position: absolute;
+ height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
+}
+
+#TB_iframeContent{
+ clear:both;
+ border:none;
+ margin-bottom:-1px;
+ margin-top:1px;
+ _margin-bottom:1px;
+}
+
+/* @end */
+
+/* @group Debugging Section */
+
+#debugging-toggle {
+ text-align: center;
+}
+#debugging-toggle img {
+ cursor: pointer;
+}
+
+#rdoc-debugging-section-dump {
+ display: none;
+ margin: 0 2em 2em;
+ background: #ccc;
+ border: 1px solid #999;
+}
+
+
+
+/* @end */
+++ /dev/null
-#!/usr/bin/make -f
-
-# This is the makefile used by debian/rules when invoked by rake deb
-
-DESTDIR=
-
-build:
-
-clean:
-
-install: install-bin install-lib install-conf install-plugins install-doc
-
-install-bin:
- install -d $(DESTDIR)/usr/sbin
- install -d $(DESTDIR)/usr/bin
- cp bin/mc-* $(DESTDIR)/usr/sbin
- cp bin/mco $(DESTDIR)/usr/bin
- cp bin/mcollectived $(DESTDIR)/usr/sbin/mcollectived
-
-install-lib:
- install -d $(DESTDIR)/usr/lib/ruby/vendor_ruby/
- cp -a lib/* $(DESTDIR)/usr/lib/ruby/vendor_ruby/
-
-install-conf:
- install -d $(DESTDIR)/etc/mcollective/
- install -d $(DESTDIR)/etc/init.d
- cp -r etc/* $(DESTDIR)/etc/mcollective/
- cp mcollective.init $(DESTDIR)/etc/init.d/mcollective
- rm $(DESTDIR)/etc/mcollective/ssl/PLACEHOLDER
- rm $(DESTDIR)/etc/mcollective/ssl/clients/PLACEHOLDER
-
-install-plugins:
- install -d $(DESTDIR)/usr/share/mcollective/
- cp -a plugins $(DESTDIR)/usr/share/mcollective/
-
-install-doc:
- install -d $(DESTDIR)/usr/share/doc/
- cp -a doc $(DESTDIR)/usr/share/doc/mcollective
-
-uninstall:
- rm -f $(DESTDIR)/usr/sbin/mcollectived
- rm -rf $(DESTDIR)/usr/lib/ruby/1.8/mcollective*
- rm -rf $(DESTDIR)/usr/share/mcollective
- rm -rf $(DESTDIR)/etc/mcollective
-
-.PHONY: build clean install uninstall
+++ /dev/null
-Makefile
-blib
-pm_to_blib
--- /dev/null
+---
+packaging_url: 'git://github.com/puppetlabs/packaging.git --branch=master'
+packaging_repo: 'packaging'
+default_cow: 'base-squeeze-i386.cow'
+cows: 'base-lucid-i386.cow base-precise-i386.cow base-quantal-i386.cow base-raring-i386.cow base-sid-i386.cow base-squeeze-i386.cow base-stable-i386.cow base-testing-i386.cow base-unstable-i386.cow base-wheezy-i386.cow base-saucy-i386.cow'
+pbuild_conf: '/etc/pbuilderrc'
+packager: 'puppetlabs'
+gpg_name: 'info@puppetlabs.com'
+gpg_key: '4BD6EC30'
+sign_tar: FALSE
+# a space separated list of mock configs
+final_mocks: 'pl-el-5-i386 pl-el-6-i386 pl-fedora-18-i386 pl-fedora-19-i386'
+yum_host: 'yum.puppetlabs.com'
+yum_repo_path: '/opt/repository/yum/'
+build_gem: TRUE
+build_dmg: FALSE
+build_doc: TRUE
+build_ips: FALSE
+apt_host: 'apt.puppetlabs.com'
+apt_repo_url: 'http://apt.puppetlabs.com'
+apt_repo_path: '/opt/repository/incoming'
--- /dev/null
+mcollective (2.3.3-1puppetlabs1) unstable sid squeeze wheezy precise; urgency=low
+
+ * Update to version 2.3.3-1puppetlabs1
+
+ -- Puppet Labs Release <info@puppetlabs.com> Fri, 15 Nov 2013 12:53:51 +0000
Section: utils
Priority: extra
Maintainer: Riccardo Setti <giskard@debian.org>
-Build-Depends: debhelper (>= 7), dpatch, cdbs
+Build-Depends: debhelper (>= 7), quilt, cdbs, ruby
Standards-Version: 3.8.0
Homepage: http://marionette-collective.org/
Architecture: all
Depends: ruby (>= 1.8.1), mcollective-common (= ${source:Version})
Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
+ The Marionette Collective aka. mcollective is a framework
to build server orchestration or parallel job execution systems.
Package: mcollective-client
Architecture: all
Depends: ruby (>= 1.8.1), mcollective-common (= ${source:Version})
Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
+ The Marionette Collective aka. mcollective is a framework
to build server orchestration or parallel job execution system
Package: mcollective-common
Architecture: all
Depends: ruby (>= 1.8.1) , rubygems, ruby-stomp | libstomp-ruby
Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
+ The Marionette Collective aka. mcollective is a framework
to build server orchestration or parallel job execution systems.
.
Common files for mcollective packages.
Architecture: all
Section: doc
Description: Documentation for mcollective
- The Marionette Collective aka. mcollective is a framework
+ The Marionette Collective aka. mcollective is a framework
to build server orchestration or parallel job execution systems.
.
Documentation package.
+++ /dev/null
-usr/lib/ruby/vendor_ruby
--- /dev/null
+etc/mcollective/ssl/clients
+etc/mcollective/plugin.d
$0 start
fi
;;
+ force-reload)
+ echo "not implemented"
+ ;;
status)
status_of_proc -p ${pidfile} ${mcollectived} ${name} && exit 0 || exit $?
;;
-usr/sbin/mcollectived usr/sbin
-etc/mcollective/facts.yaml etc/mcollective
-etc/mcollective/server.cfg etc/mcollective
-etc/init.d etc/
-etc/mcollective/ssl
+usr/sbin/mcollectived
+etc/mcollective/facts.yaml
+etc/mcollective/server.cfg
+++ /dev/null
-pluginsdir.dpatch
+++ /dev/null
-#! /bin/sh /usr/share/dpatch/dpatch-run
-## conffile.dpatch by <giskard@debian.org
-##
-## All lines beginning with `## DP:' are a description of the patch.
-## DP: default config options
-
-@DPATCH@
-diff -urNad mcollective-0.4.1~/etc/client.cfg mcollective-0.4.1/etc/client.cfg
---- mcollective-0.4.1~/etc/client.cfg 1970-01-01 00:00:00.000000000 +0000
-+++ mcollective-0.4.1/etc/client.cfg 2010-01-06 14:37:24.000000000 +0000
-@@ -0,0 +1,19 @@
-+libdir = /usr/share/mcollective/plugins
-+logger_type = console
-+loglevel = warn
-+
-+# Plugins
-+securityprovider = psk
-+plugin.psk = unset
-+
-+connector = activemq
-+plugin.activemq.pool.size = 1
-+plugin.activemq.pool.1.host = stomp1
-+plugin.activemq.pool.1.port = 6163
-+plugin.activemq.pool.1.user = mcollective
-+plugin.activemq.pool.1.password = marionette
-+
-+# Facts
-+factsource = yaml
-+plugin.yaml = /etc/mcollective/facts.yaml
-+
-diff -urNad mcollective-0.4.1~/etc/client.cfg.dist mcollective-0.4.1/etc/client.cfg.dist
---- mcollective-0.4.1~/etc/client.cfg.dist 2010-01-02 14:54:25.000000000 +0000
-+++ mcollective-0.4.1/etc/client.cfg.dist 1970-01-01 00:00:00.000000000 +0000
-@@ -1,19 +0,0 @@
--libdir = /usr/libexec/mcollective
--logger_type = console
--loglevel = warn
--
--# Plugins
--securityprovider = psk
--plugin.psk = unset
--
--connector = stomp
--plugin.stomp.host = stomp.your.com
--plugin.stomp.port = 6163
--plugin.stomp.user = mcollective
--plugin.stomp.password = marionette
--
--# Facts
--factsource = yaml
--plugin.yaml = /etc/mcollective/facts.yaml
--
-diff -urNad mcollective-0.4.1~/etc/facts.yaml mcollective-0.4.1/etc/facts.yaml
---- mcollective-0.4.1~/etc/facts.yaml 1970-01-01 00:00:00.000000000 +0000
-+++ mcollective-0.4.1/etc/facts.yaml 2010-01-06 14:37:27.000000000 +0000
-@@ -0,0 +1,2 @@
-+---
-+mcollective: 1
-diff -urNad mcollective-0.4.1~/etc/facts.yaml.dist mcollective-0.4.1/etc/facts.yaml.dist
---- mcollective-0.4.1~/etc/facts.yaml.dist 2010-01-02 14:54:25.000000000 +0000
-+++ mcollective-0.4.1/etc/facts.yaml.dist 1970-01-01 00:00:00.000000000 +0000
-@@ -1,2 +0,0 @@
-----
--mcollective: 1
-diff -urNad mcollective-0.4.1~/etc/server.cfg mcollective-0.4.1/etc/server.cfg
---- mcollective-0.4.1~/etc/server.cfg 1970-01-01 00:00:00.000000000 +0000
-+++ mcollective-0.4.1/etc/server.cfg 2010-01-06 14:37:50.000000000 +0000
-@@ -0,0 +1,20 @@
-+libdir = /usr/share/mcollective/plugins
-+logfile = /var/log/mcollective.log
-+loglevel = info
-+daemonize = 1
-+
-+# Plugins
-+securityprovider = psk
-+plugin.psk = unset
-+
-+connector = activemq
-+plugin.activemq.pool.size = 1
-+plugin.activemq.pool.1.host = stomp1
-+plugin.activemq.pool.1.port = 6163
-+plugin.activemq.pool.1.user = mcollective
-+plugin.activemq.pool.1.password = marionette
-+
-+# Facts
-+factsource = yaml
-+plugin.yaml = /etc/mcollective/facts.yaml
-+
-diff -urNad mcollective-0.4.1~/etc/server.cfg.dist mcollective-0.4.1/etc/server.cfg.dist
---- mcollective-0.4.1~/etc/server.cfg.dist 2010-01-02 14:54:25.000000000 +0000
-+++ mcollective-0.4.1/etc/server.cfg.dist 1970-01-01 00:00:00.000000000 +0000
-@@ -1,20 +0,0 @@
--libdir = /usr/libexec/mcollective
--logfile = /var/log/mcollective.log
--loglevel = info
--daemonize = 1
--
--# Plugins
--securityprovider = psk
--plugin.psk = unset
--
--connector = stomp
--plugin.stomp.host = stomp.your.com
--plugin.stomp.port = 6163
--plugin.stomp.user = mcollective
--plugin.stomp.password = marionette
--
--# Facts
--factsource = yaml
--plugin.yaml = /etc/mcollective/facts.yaml
--
+++ /dev/null
-#! /bin/sh /usr/share/dpatch/dpatch-run
-## initlsb.dpatch by <giskard@debian.org
-##
-## All lines beginning with `## DP:' are a description of the patch.
-## DP: Init func.
-
-@DPATCH@
-diff -urNad mcollective-0.4.1~/mcollective.init mcollective-0.4.1/mcollective.init
---- mcollective-0.4.1~/mcollective.init 2010-01-02 14:54:25.000000000 +0000
-+++ mcollective-0.4.1/mcollective.init 2010-01-07 10:52:38.000000000 +0000
-@@ -8,6 +8,15 @@
- # much about all the setup and management of a Stomp connection, it also provides stats, logging and so forth
- # as a bonus.
- #
-+### BEGIN INIT INFO
-+# Provides: scriptname
-+# Required-Start: $remote_fs $syslog
-+# Required-Stop: $remote_fs $syslog
-+# Default-Start: 2 3 4 5
-+# Default-Stop: 0 1 6
-+# Short-Description: Start daemon at boot time
-+# Description: Enable service provided by daemon.
-+### END INIT INFO
-
- RUBYLIB=/usr/local/lib/site_ruby/1.8:$RUBYLIB
- export RUBYLIB
-@@ -104,7 +113,10 @@
- echo "mcollectived: service not started"
- exit 1
- fi
-- ;;
-+ ;;
-+ force-reload)
-+ echo "not implemented"
-+ ;;
- *)
- echo "Usage: mcollectived {start|stop|restart|condrestart|status}"
- exit 1
+++ /dev/null
-#! /bin/sh /usr/share/dpatch/dpatch-run
-## makefile.dpatch by <giskard@debian.org
-##
-## All lines beginning with `## DP:' are a description of the patch.
-## DP: Add Makefile for install task
-
-@DPATCH@
-diff -urNad mcollective-0.4.1~/Makefile mcollective-0.4.1/Makefile
---- mcollective-0.4.1~/Makefile 1970-01-01 00:00:00.000000000 +0000
-+++ mcollective-0.4.1/Makefile 2010-01-06 13:43:56.000000000 +0000
-@@ -0,0 +1,38 @@
-+#!/usr/bin/make -f
-+
-+DESTDIR=
-+
-+clean:
-+
-+install: install-bin install-lib install-conf install-plugins install-doc
-+
-+install-bin:
-+ install -d $(DESTDIR)/usr/sbin
-+ cp mc-* $(DESTDIR)/usr/sbin
-+ cp mcollectived.rb $(DESTDIR)/usr/sbin/mcollectived
-+
-+install-lib:
-+ install -d $(DESTDIR)/usr/lib/ruby/vendor_ruby/
-+ cp -a lib/* $(DESTDIR)/usr/lib/ruby/vendor_ruby/
-+
-+install-conf:
-+ install -d $(DESTDIR)/etc/mcollective/
-+ install -d $(DESTDIR)/etc/init.d
-+ cp etc/* $(DESTDIR)/etc/mcollective/
-+ cp mcollective.init $(DESTDIR)/etc/init.d/mcollective
-+
-+install-plugins:
-+ install -d $(DESTDIR)/usr/share/mcollective/
-+ cp -a plugins $(DESTDIR)/usr/share/mcollective/
-+
-+install-doc:
-+ install -d $(DESTDIR)/usr/share/doc/
-+ cp -a doc $(DESTDIR)/usr/share/doc/mcollective
-+
-+uninstall:
-+ rm -f $(DESTDIR)/usr/sbin/mcollectived
-+ rm -rf $(DESTDIR)/usr/lib/ruby/vendor_ruby/mcollective*
-+ rm -rf $(DESTDIR)/usr/share/mcollective
-+ rm -rf $(DESTDIR)/etc/mcollective
-+
-+.PHONY: clean install uninstall
+++ /dev/null
-#! /bin/sh /usr/share/dpatch/dpatch-run
-## pluginsdir.dpatch by <gisakrd@debian.org>
-##
-## All lines beginning with `## DP:' are a description of the patch.
-## DP: fix plugins dir
-
-@DPATCH@
-diff -urNad mcollective-1.1.4~/etc/client.cfg.dist mcollective-1.1.4/etc/client.cfg.dist
---- mcollective-1.1.4~/etc/client.cfg.dist 2011-04-06 14:13:08.829462165 -0700
-+++ mcollective-1.1.4/etc/client.cfg.dist 2011-04-06 14:12:53.129384114 -0700
-@@ -1,6 +1,6 @@
- main_collective = mcollective
- collectives = mcollective
--libdir = /usr/libexec/mcollective
-+libdir = /usr/share/mcollective/plugins
- logger_type = console
- loglevel = warn
-
-diff -urNad mcollective-1.1.4~/etc/server.cfg.dist mcollective-1.1.4/etc/server.cfg.dist
---- mcollective-1.1.4~/etc/server.cfg.dist 2011-04-06 14:12:30.889527230 -0700
-+++ mcollective-1.1.4/etc/server.cfg.dist 2011-04-06 14:12:23.779407065 -0700
-@@ -1,6 +1,6 @@
- main_collective = mcollective
- collectives = mcollective
--libdir = /usr/libexec/mcollective
-+libdir = /usr/share/mcollective/plugins
- logfile = /var/log/mcollective.log
- loglevel = info
- daemonize = 1
-
--- /dev/null
+diff --git a/etc/client.cfg.dist b/etc/client.cfg.dist
+index 1acffee..5c36486 100644
+--- a/etc/client.cfg.dist
++++ b/etc/client.cfg.dist
+@@ -1,6 +1,6 @@
+ main_collective = mcollective
+ collectives = mcollective
+-libdir = /usr/libexec/mcollective
++libdir = /usr/share/mcollective/plugins
+ logger_type = console
+ loglevel = warn
+
+diff --git a/etc/server.cfg.dist b/etc/server.cfg.dist
+index 2038324..c28a826 100644
+--- a/etc/server.cfg.dist
++++ b/etc/server.cfg.dist
+@@ -1,6 +1,6 @@
+ main_collective = mcollective
+ collectives = mcollective
+-libdir = /usr/libexec/mcollective
++libdir = /usr/share/mcollective/plugins
+ logfile = /var/log/mcollective.log
+ loglevel = info
+ daemonize = 1
--- /dev/null
+pluginsdir.patch
#!/usr/bin/make -f
-DEB_MAKE_CLEAN_TARGET :=
-DEB_MAKE_INSTALL_TARGET := install DESTDIR=$(CURDIR)/debian/tmp
-
include /usr/share/cdbs/1/rules/debhelper.mk
-include /usr/share/cdbs/1/rules/dpatch.mk
-include /usr/share/cdbs/1/class/makefile.mk
-DEB_MAKE_INVOKE = $(DEB_MAKE_ENVVARS) make -f ext/Makefile.debian -C $(DEB_BUILDDIR)
+BUILD_ROOT=$(CURDIR)/debian/tmp
+RUBY_LIBDIR=$(shell /usr/bin/ruby -rrbconfig -e 'puts RbConfig::CONFIG["vendordir"]')
+PLUGINDIR=/usr/share/mcollective/plugins
+DOCDIR=$(BUILD_ROOT)/usr/share/doc/mcollective
install/mcollective::
- mv $(CURDIR)/debian/tmp/etc/mcollective/server.cfg.dist $(CURDIR)/debian/tmp/etc/mcollective/server.cfg
- mv $(CURDIR)/debian/tmp/etc/mcollective/client.cfg.dist $(CURDIR)/debian/tmp/etc/mcollective/client.cfg
- mv $(CURDIR)/debian/tmp/etc/mcollective/facts.yaml.dist $(CURDIR)/debian/tmp/etc/mcollective/facts.yaml
-# dh_installinit -pmcollective -o
+ /usr/bin/ruby install.rb --destdir=$(CURDIR)/debian/tmp --no-rdoc --sitelibdir=$(RUBY_LIBDIR) --ruby=/usr/bin/ruby --plugindir=$(PLUGINDIR)
+ mkdir -p $(DOCDIR)
+ cp -a doc/* $(DOCDIR)
binary-fixup/mcollective::
chmod 640 $(CURDIR)/debian/mcollective/etc/mcollective/server.cfg
--- /dev/null
+3.0 (quilt)
--- /dev/null
+build_defs_file = File.join(RAKE_ROOT, 'ext', 'build_defaults.yaml')
+if File.exist?(build_defs_file)
+ begin
+ require 'yaml'
+ @build_defaults ||= YAML.load_file(build_defs_file)
+ rescue Exception => e
+ STDERR.puts "Unable to load yaml from #{build_defs_file}:"
+ raise e
+ end
+ @packaging_url = @build_defaults['packaging_url']
+ @packaging_repo = @build_defaults['packaging_repo']
+ raise "Could not find packaging url in #{build_defs_file}" if @packaging_url.nil?
+ raise "Could not find packaging repo in #{build_defs_file}" if @packaging_repo.nil?
+
+ namespace :package do
+ desc "Bootstrap packaging automation, e.g. clone into packaging repo"
+ task :bootstrap do
+ if File.exist?(File.join(RAKE_ROOT, "ext", @packaging_repo))
+ puts "It looks like you already have ext/#{@packaging_repo}. If you don't like it, blow it away with package:implode."
+ else
+ cd File.join(RAKE_ROOT, 'ext') do
+ %x{git clone #{@packaging_url}}
+ end
+ end
+ end
+ desc "Remove all cloned packaging automation"
+ task :implode do
+ rm_rf File.join(RAKE_ROOT, "ext", @packaging_repo)
+ end
+ end
+end
+
+begin
+ load File.join(RAKE_ROOT, 'ext', 'packaging', 'packaging.rake')
+rescue LoadError
+end
--- /dev/null
+---
+project: 'mcollective'
+author: 'Puppet Labs'
+email: 'info@puppetlabs.com'
+homepage: 'https://docs.puppetlabs.com/mcollective/'
+summary: 'Application Server for hosting Ruby code on any capable middleware'
+description: 'The Marionette Collective, e.g. mcollective, is a framework for building server orchestration or parallel job execution systems.'
+version_file: 'lib/mcollective.rb'
+update_version_file: true
+version_strategy: 'odd_even'
+# files and gem_files are space separated lists
+files: 'mcollective.init COPYING doc etc lib plugins ext bin install.rb'
+# List of packaging related templates to evaluate before the tarball is packed
+templates:
+ - "ext/redhat/mcollective.spec.erb"
+ - "ext/debian/changelog.erb"
+# The gem is only built for the mcollective client
+gem_name: 'mcollective-client'
+gem_summary: 'Client libraries for the Mcollective Application Server'
+gem_description: 'Client libraries for the Mcollective Application Server'
+gem_files: 'lib bin'
+gem_test_files: 'spec/**/*'
+gem_require_path: 'lib'
+gem_executables: 'mco'
+gem_default_executables: 'mco'
+gem_excludes: "bin/mcollectived lib/mcollective/runner.rb lib/mcollective/vendor/json lib/mcollective/vendor/load_json.rb lib/mcollective/vendor/systemu lib/mcollective/vendor/load_systemu.rb lib/mcollective/vendor/i18n lib/mcollective/vendor/load_i18n.rb"
+gem_runtime_dependencies:
+ systemu:
+ json:
+ stomp:
+ i18n:
+gem_rdoc_options:
+ - --line-numbers
+ - --main
+ - Mcollective
+ - --exclude
+ - mcollective/vendor
+ - --exclude
+ - spec
+ - --exclude
+ - ext
+ - --exclude
+ - website
+ - --exclude
+ - plugins
--- /dev/null
+[Unit]
+Description=The Marionette Collective
+After=network.target
+
+[Service]
+Type=forking
+StandardOutput=syslog
+StandardError=syslog
+ExecStart=/usr/sbin/mcollectived --config=/etc/mcollective/server.cfg --pidfile=/var/run/mcollective.pid
+ExecReload=/bin/kill -USR1 $MAINPID
+PIDFile=/var/run/mcollective.pid
+
+[Install]
+WantedBy=multi-user.target
-# Fedora 19 ships with ruby 2, which uses vendorlibdir instead
-# of sitelibdir
-%if 0%{?fedora} >= 19
-%global ruby_libdir %(ruby -rrbconfig -e 'puts RbConfig::CONFIG["vendorlibdir"]')
+# Fedora 17 and later use vendorlibdir instead of sitelibdir (see https://fedoraproject.org/wiki/Packaging:Ruby?rd=Packaging/Ruby#Pure_Ruby_packages)
+%if 0%{?fedora} >= 17 || 0%{?rhel} >= 7
+%global ruby_libdir %(ruby -rrbconfig -e 'puts RbConfig::CONFIG["vendorlibdir"]')
%else
-%global ruby_libdir %(ruby -rrbconfig -e "puts RbConfig::CONFIG['sitelibdir']")
+%global ruby_libdir %(ruby -rrbconfig -e "puts RbConfig::CONFIG['sitelibdir']")
%endif
-%define release %{rpm_release}%{?dist}
-
-Summary: Application Server for hosting Ruby code on any capable middleware
-Name: mcollective
-Version: %{version}
-Release: %{release}
-Group: System Environment/Daemons
-License: ASL 2.0
-URL: http://puppetlabs.com/mcollective/introduction/
-Source0: http://downloads.puppetlabs.com/mcollective/%{name}-%{version}.tgz
-BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n)
-Requires: mcollective-common = %{version}-%{release}
-Packager: R.I.Pienaar <rip@devco.net>
-BuildArch: noarch
+%if 0%{?fedora} >= 17 || 0%{?rhel} >= 7
+%global _with_systemd 1
+%else
+%global _with_systemd 0
+%endif
+
+# VERSION is subbed out during rake package:srpm process
+%global realversion 2.3.3
+%global rpmversion 2.3.3
+
+Summary: Application Server for hosting Ruby code on any capable middleware
+Name: mcollective
+Version: %{rpmversion}
+Release: 1%{?dist}
+Group: System Environment/Daemons
+License: ASL 2.0
+URL: http://puppetlabs.com/mcollective/introduction/
+Source0: http://downloads.puppetlabs.com/mcollective/%{name}-%{realversion}.tar.gz
+BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n)
+BuildRequires: ruby >= 1.8
+Requires: mcollective-common = %{version}-%{release}
+Packager: Puppet Labs <info@puppetlabs.com>
+BuildArch: noarch
+
+%if 0%{?_with_systemd}
+# Required for %%post, %%preun, %%postun
+Requires: systemd
+%if 0%{?fedora} >= 18
+BuildRequires: systemd
+%else
+BuildRequires: systemd-units
+%endif
+%else
+# Required for %%post and %%preun
+Requires: chkconfig
+# Required for %%preun and %%postun
+Requires: initscripts
+%endif
+
+%description
+The Marionette Collective:
+
+Server for the mcollective Application Server
%package common
-Summary: Common libraries for the mcollective clients and servers
-Group: System Environment/Libraries
-Requires: ruby >= 1.8
-Requires: rubygems
-Requires: rubygem(stomp)
+Summary: Common libraries for the mcollective clients and servers
+Group: System Environment/Libraries
+Requires: ruby >= 1.8
+Requires: rubygems
+Requires: rubygem-stomp
%description common
The Marionette Collective:
Common libraries for the mcollective clients and servers
%package client
-Summary: Client tools for the mcollective Application Server
-Requires: mcollective-common = %{version}-%{release}
-Group: Applications/System
+Summary: Client tools for the mcollective Application Server
+Requires: mcollective-common = %{version}-%{release}
+Group: Applications/System
%description client
The Marionette Collective:
Client tools for the mcollective Application Server
-%description
-The Marionette Collective:
-
-Server for the mcollective Application Server
-
%prep
-%setup -q
+%setup -q -n %{name}-%{realversion}
%build
%install
rm -rf %{buildroot}
-%{__install} -d -m0755 %{buildroot}/%{ruby_libdir}/mcollective
-%{__install} -d -m0755 %{buildroot}%{_bindir}
-%{__install} -d -m0755 %{buildroot}%{_sbindir}
+
+ruby install.rb --destdir=%{buildroot} --no-rdoc --sitelibdir=%{ruby_libdir} --plugindir=%{_libexecdir}/mcollective
+
+%if 0%{?_with_systemd}
+%{__install} -d -m0755 %{buildroot}%{_unitdir}
+%{__install} -m0644 ext/redhat/mcollective.service %{buildroot}%{_unitdir}/mcollective.service
+%else
%{__install} -d -m0755 %{buildroot}%{_sysconfdir}/init.d
-%{__install} -d -m0755 %{buildroot}%{_libexecdir}/mcollective/
-%{__install} -d -m0755 %{buildroot}%{_sysconfdir}/mcollective
-%{__install} -d -m0755 %{buildroot}%{_sysconfdir}/mcollective/plugin.d
-%{__install} -d -m0755 %{buildroot}%{_sysconfdir}/mcollective/ssl
-%{__install} -d -m0755 %{buildroot}%{_sysconfdir}/mcollective/ssl/clients
-%{__install} -m0755 bin/mcollectived %{buildroot}%{_sbindir}/mcollectived
-%{__install} -m0640 etc/server.cfg.dist %{buildroot}%{_sysconfdir}/mcollective/server.cfg
-%{__install} -m0644 etc/client.cfg.dist %{buildroot}%{_sysconfdir}/mcollective/client.cfg
-%{__install} -m0444 etc/facts.yaml.dist %{buildroot}%{_sysconfdir}/mcollective/facts.yaml
-%{__install} -m0444 etc/rpc-help.erb %{buildroot}%{_sysconfdir}/mcollective/rpc-help.erb
-%{__install} -m0444 etc/data-help.erb %{buildroot}%{_sysconfdir}/mcollective/data-help.erb
-%{__install} -m0444 etc/discovery-help.erb %{buildroot}%{_sysconfdir}/mcollective/discovery-help.erb
-%{__install} -m0444 etc/metadata-help.erb %{buildroot}%{_sysconfdir}/mcollective/metadata-help.erb
-%{__install} -m0444 etc/msg-help.erb %{buildroot}%{_sysconfdir}/mcollective/msg-help.erb
%if 0%{?suse_version}
%{__install} -m0755 mcollective.init %{buildroot}%{_sysconfdir}/init.d/mcollective
%else
%{__install} -m0755 ext/redhat/mcollective.init %{buildroot}%{_sysconfdir}/init.d/mcollective
%endif
+%endif
-
-cp -R lib/* %{buildroot}/%{ruby_libdir}/
-cp -R plugins/* %{buildroot}%{_libexecdir}/mcollective/
-cp bin/mc-* %{buildroot}%{_sbindir}/
-cp bin/mco %{buildroot}%{_bindir}/
-chmod 0755 %{buildroot}%{_sbindir}/*
+%{__install} -d -m0755 %{buildroot}%{_sysconfdir}/mcollective/plugin.d
+%{__install} -d -m0755 %{buildroot}%{_sysconfdir}/mcollective/ssl/clients
%clean
rm -rf %{buildroot}
%post
+%if 0%{?_with_systemd}
+if [ $1 -eq 1 ] ; then
+ /bin/systemctl daemon-reload >/dev/null 2>&1 || :
+fi
+%else
/sbin/chkconfig --add mcollective || :
+%endif
%postun
+%if 0%{?_with_systemd}
+if [ $1 -ge 1 ] ; then
+ # Package upgrade, not uninstall
+ /bin/systemctl try-restart mcollective.service >/dev/null 2>&1 || :
+fi
+%else
if [ "$1" -ge 1 ]; then
/sbin/service mcollective condrestart &>/dev/null || :
fi
+%endif
%preun
+%if 0%{?_with_systemd}
+if [ $1 -eq 0 ] ; then
+ # Package removal, not upgrade
+ /bin/systemctl --no-reload disable mcollective.service > /dev/null 2>&1 || :
+ /bin/systemctl stop mcollective.service > /dev/null 2>&1 || :
+fi
+%else
if [ "$1" = 0 ] ; then
/sbin/service mcollective stop > /dev/null 2>&1
/sbin/chkconfig --del mcollective || :
fi
+%endif
%files common
+%defattr(-, root, root, 0755)
%doc COPYING
+%doc doc
%{ruby_libdir}/mcollective.rb
%{ruby_libdir}/mcollective
%{_libexecdir}/mcollective/mcollective
%config %{_sysconfdir}/mcollective/*.erb
%files client
+%defattr(-, root, root, 0755)
%attr(0755, root, root)%{_sbindir}/mc-call-agent
%attr(0755, root, root)%{_bindir}/mco
%doc COPYING
%{_libexecdir}/mcollective/mcollective/pluginpackager
%files
+%defattr(-, root, root, 0755)
%doc COPYING
-%{_sbindir}/mcollectived
+%attr(0755, root, root)%{_sbindir}/mcollectived
+%if 0%{?_with_systemd}
+%{_unitdir}/mcollective.service
+%else
%{_sysconfdir}/init.d/mcollective
+%endif
%config(noreplace)%{_sysconfdir}/mcollective/server.cfg
%config(noreplace)%{_sysconfdir}/mcollective/facts.yaml
%dir %{_sysconfdir}/mcollective/ssl/clients
%config(noreplace)%{_sysconfdir}/mcollective/plugin.d
%changelog
+* Fri Nov 15 2013 Puppet Labs Release <info@puppetlabs.com> - 2.3.3-1
+- Build for 2.3.3
+
* Tue Nov 03 2009 R.I.Pienaar <rip@devco.net>
- First release
--- /dev/null
+#! /usr/bin/env ruby
+#--
+# Copyright 2004 Austin Ziegler <ruby-install@halostatue.ca>
+# Install utility. Based on the original installation script for rdoc by the
+# Pragmatic Programmers.
+#
+# This program is free software. It may be redistributed and/or modified under
+# the terms of the GPL version 2 (or later) or the Ruby licence.
+#
+# Usage
+# -----
+# In most cases, if you have a typical project layout, you will need to do
+# absolutely nothing to make this work for you. This layout is:
+#
+# bin/ # executable files -- "commands"
+# lib/ # the source of the library
+#
+# The default behaviour:
+# 1) Build Rdoc documentation from all files in bin/ (excluding .bat and .cmd),
+# all .rb files in lib/, ./README, ./ChangeLog, and ./Install.
+# and all .rb files in lib/.
+# 2) Install configuration files in etc/.
+# 3) Install commands from bin/ into the Ruby bin directory.
+# 4) Install system commands from bin/ into the Ruby sbin directory.
+# 5) Install all library files from lib/ into Ruby's site_lib/version
+# directory.
+# 6) Install all plugins from plugins/ into the plugins directory
+# (usually $libexecdir/mcollective).
+#
+#++
+
+require 'rbconfig'
+require 'find'
+require 'fileutils'
+require 'tempfile'
+require 'optparse'
+require 'ostruct'
+include FileUtils
+
+begin
+ require 'rdoc/rdoc'
+ $haverdoc = true
+rescue LoadError
+ puts "Missing rdoc; skipping documentation"
+ $haverdoc = false
+end
+
+if (defined?(RbConfig) ? RbConfig : Config)::CONFIG['host_os'] =~ /mswin|win32|dos|mingw|cygwin/i
+ $stderr.puts "install.rb does not support Microsoft Windows. See ext/windows/README.md for information on installing on Microsoft Windows."
+ exit(-1)
+end
+
+PREREQS = %w{}
+
+InstallOptions = OpenStruct.new
+
+def glob(list)
+ g = list.map { |i| Dir.glob(i) }
+ g.flatten!
+ g.compact!
+ g.uniq!
+ g
+end
+
+def check_prereqs
+ PREREQS.each do |pre|
+ begin
+ require pre
+ rescue LoadError
+ puts "Could not load #{pre} Ruby library; cannot install"
+ exit(-1)
+ end
+ end
+end
+
+def do_configs(configs, target, strip = 'etc/')
+ Dir.mkdir(target) unless File.directory? target
+ configs.each do |cf|
+ ocf = File.join(target, cf.gsub(Regexp.new(strip), ''))
+ oc = File.dirname(ocf)
+ makedirs(oc, {:mode => 0755, :verbose => true})
+ install(cf, ocf, {:mode => 0644, :preserve => true, :verbose => true})
+ end
+end
+
+def do_bins(bins, target, strip = 's?bin/')
+ Dir.mkdir(target) unless File.directory? target
+ bins.each do |bf|
+ obf = bf.gsub(/#{strip}/, '')
+ install_binfile(bf, obf, target)
+ end
+end
+
+def do_libs(libs, target, strip = 'lib/')
+ libs.each do |lf|
+ olf = File.join(target, lf.sub(/^#{strip}/, ''))
+ op = File.dirname(olf)
+ if File.directory?(lf)
+ makedirs(olf, {:mode => 0755, :verbose => true})
+ else
+ makedirs(op, {:mode => 0755, :verbose => true})
+ install(lf, olf, {:mode => 0644, :preserve => true, :verbose => true})
+ end
+ end
+end
+
+##
+# Prepare the file installation.
+#
+def prepare_installation
+ InstallOptions.configs = true
+
+ # Only try to do docs if we're sure they have rdoc
+ if $haverdoc
+ InstallOptions.rdoc = true
+ else
+ InstallOptions.rdoc = false
+ end
+
+
+ ARGV.options do |opts|
+ opts.banner = "Usage: #{File.basename($0)} [options]"
+ opts.separator ""
+ opts.on('--[no-]rdoc', 'Creation of RDoc output.', 'Default is create rdoc.') do |onrdoc|
+ InstallOptions.rdoc = onrdoc
+ end
+ opts.on('--[no-]configs', 'Installation of config files', 'Default is install configs.') do |onconfigs|
+ InstallOptions.configs = onconfigs
+ end
+ opts.on('--destdir[=OPTIONAL]', 'Installation prefix for all targets', 'Default essentially /') do |destdir|
+ InstallOptions.destdir = destdir
+ end
+ opts.on('--configdir[=OPTIONAL]', 'Installation directory for config files', 'Default /etc/mcollective') do |configdir|
+ InstallOptions.configdir = configdir
+ end
+ opts.on('--bindir[=OPTIONAL]', 'Installation directory for binaries', 'overrides RbConfig::CONFIG["bindir"]') do |bindir|
+ InstallOptions.bindir = bindir
+ end
+ opts.on('--sbindir[=OPTIONAL]', 'Installation directory for system binaries', 'overrides RbConfig::CONFIG["sbindir"]') do |sbindir|
+ InstallOptions.sbindir = sbindir
+ end
+ opts.on('--ruby[=OPTIONAL]', 'Ruby interpreter to use with installation', 'overrides ruby used to call install.rb') do |ruby|
+ InstallOptions.ruby = ruby
+ end
+ opts.on('--sitelibdir[=OPTIONAL]', 'Installation directory for libraries', 'overrides RbConfig::CONFIG["sitelibdir"]') do |sitelibdir|
+ InstallOptions.sitelibdir = sitelibdir
+ end
+ opts.on('--plugindir[=OPTIONAL]', 'Installation directory for plugins', 'Default /usr/libexec/mcollective') do |plugindir|
+ InstallOptions.plugindir = plugindir
+ end
+ opts.on('--quick', 'Performs a quick installation. Only the', 'installation is done.') do |quick|
+ InstallOptions.rdoc = false
+ InstallOptions.ri = false
+ InstallOptions.configs = true
+ end
+ opts.on('--full', 'Performs a full installation. All', 'optional installation steps are run.') do |full|
+ InstallOptions.rdoc = true
+ InstallOptions.ri = true
+ InstallOptions.configs = true
+ end
+ opts.separator("")
+ opts.on_tail('--help', "Shows this help text.") do
+ $stderr.puts opts
+ exit
+ end
+
+ opts.parse!
+ end
+
+ version = [RbConfig::CONFIG["MAJOR"], RbConfig::CONFIG["MINOR"]].join(".")
+ libdir = File.join(RbConfig::CONFIG["libdir"], "ruby", version)
+
+ # Mac OS X 10.5 and higher declare bindir
+ # /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin
+ # which is not generally where people expect executables to be installed
+ # These settings are appropriate defaults for all OS X versions.
+ if RUBY_PLATFORM =~ /^universal-darwin[\d\.]+$/
+ RbConfig::CONFIG['bindir'] = "/usr/bin"
+ RbConfig::CONFIG['sbindir'] = "/usr/sbin"
+ end
+
+ if InstallOptions.configdir
+ configdir = InstallOptions.configdir
+ else
+ configdir = "/etc/mcollective"
+ end
+
+ if InstallOptions.bindir
+ bindir = InstallOptions.bindir
+ else
+ bindir = RbConfig::CONFIG['bindir']
+ end
+
+ if InstallOptions.sbindir
+ sbindir = InstallOptions.sbindir
+ else
+ sbindir = RbConfig::CONFIG['sbindir']
+ end
+
+ if InstallOptions.sitelibdir
+ sitelibdir = InstallOptions.sitelibdir
+ else
+ sitelibdir = RbConfig::CONFIG["sitelibdir"]
+ if sitelibdir.nil?
+ sitelibdir = $LOAD_PATH.find { |x| x =~ /site_ruby/ }
+ if sitelibdir.nil?
+ sitelibdir = File.join(libdir, "site_ruby")
+ elsif sitelibdir !~ Regexp.quote(version)
+ sitelibdir = File.join(sitelibdir, version)
+ end
+ end
+ end
+
+ if InstallOptions.plugindir
+ plugindir = InstallOptions.plugindir
+ else
+ plugindir = "/usr/libexec/mcollective"
+ end
+
+ if InstallOptions.destdir
+ destdir = InstallOptions.destdir
+ else
+ destdir = ''
+ end
+
+ configdir = File.join(destdir, configdir)
+ bindir = File.join(destdir, bindir)
+ sbindir = File.join(destdir, sbindir)
+ sitelibdir = File.join(destdir, sitelibdir)
+ plugindir = File.join(destdir, plugindir)
+
+ makedirs(configdir) if InstallOptions.configs
+ makedirs(bindir)
+ makedirs(sbindir)
+ makedirs(sitelibdir)
+ makedirs(plugindir)
+
+ InstallOptions.sitelibdir = sitelibdir
+ InstallOptions.configdir = configdir
+ InstallOptions.bindir = bindir
+ InstallOptions.sbindir = sbindir
+ InstallOptions.plugindir = plugindir
+end
+
+##
+# Build the rdoc documentation.
+#
+def build_rdoc(files)
+ return unless $haverdoc
+ begin
+ r = RDoc::RDoc.new
+ r.document(["--main", "MCollective", "--line-numbers"] + files)
+ rescue RDoc::RDocError => e
+ $stderr.puts e.message
+ rescue Exception => e
+ $stderr.puts "Couldn't build RDoc documentation\n#{e.message}"
+ end
+end
+
+##
+# Install file(s) from ./bin to RbConfig::CONFIG['bindir']. Patch it on the way
+# to insert a #! line; on a Unix install, the command is named as expected
+def install_binfile(from, op_file, target)
+ tmp_file = Tempfile.new('mcollective-binfile')
+
+ if InstallOptions.ruby
+ ruby = InstallOptions.ruby
+ else
+ ruby = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
+ end
+
+ File.open(from) do |ip|
+ File.open(tmp_file.path, "w") do |op|
+ op.puts "#!#{ruby}"
+ contents = ip.readlines
+ contents.shift if contents[0] =~ /^#!/
+ op.write contents.join
+ end
+ end
+
+ install(tmp_file.path, File.join(target, op_file), :mode => 0755, :preserve => true, :verbose => true)
+ tmp_file.unlink
+end
+
+# Change directory into the mcollective root so we don't get the wrong files for install.
+cd File.dirname(__FILE__) do
+ # Set these values to what you want installed.
+ configs = glob(%w{etc/*.dist})
+ erbs = glob(%w{etc/*.erb})
+ bins = glob(%w{bin/mco})
+ sbins = glob(%w{bin/mcollectived bin/mc-call-agent})
+ rdoc = glob(%w{bin/* lib/**/*.rb README* })
+ libs = glob(%w{lib/**/*})
+ plugins = glob(%w{plugins/**/*})
+
+ check_prereqs
+ prepare_installation
+
+ build_rdoc(rdoc) if InstallOptions.rdoc
+ do_configs(configs, InstallOptions.configdir, 'etc/|\.dist') if InstallOptions.configs
+ do_configs(erbs, InstallOptions.configdir) if InstallOptions.configs
+ do_bins(bins, InstallOptions.bindir)
+ do_bins(sbins, InstallOptions.sbindir)
+ do_libs(libs, InstallOptions.sitelibdir)
+ do_libs(plugins, InstallOptions.plugindir, 'plugins/')
+end
MCollective::Vendor.load_vendored
- VERSION="2.3.2"
+ VERSION="2.3.3"
def self.version
VERSION
end
end
- [:stdin, :cwd, :environment].each do |k|
+ [:stdin, :cwd, :environment, :timeout].each do |k|
if options.include?(k)
shellopts[k] = options[k]
end
# stderr - a variable that will receive stdin, must support <<
# environment - the shell environment, defaults to include LC_ALL=C
# set to nil to clear the environment even of LC_ALL
+ # timeout - a timeout in seconds after which the subprocess is killed,
+ # the special value :on_thread_exit kills the subprocess
+ # when the invoking thread (typically the agent) has ended
#
class Shell
- attr_reader :environment, :command, :status, :stdout, :stderr, :stdin, :cwd
+ attr_reader :environment, :command, :status, :stdout, :stderr, :stdin, :cwd, :timeout
def initialize(command, options={})
@environment = {"LC_ALL" => "C"}
@stderr = ""
@stdin = nil
@cwd = Dir.tmpdir
+ @timeout = nil
options.each do |opt, val|
case opt.to_s
else
@environment.merge!(val.dup)
end
+ when "timeout"
+ raise "timeout should be a positive integer or the symbol :on_thread_exit symbol" unless val.eql?(:on_thread_exit) || ( val.is_a?(Fixnum) && val>0 )
+ @timeout = val
end
end
end
opts["stdin"] = @stdin if @stdin
- # Check if the parent thread is alive. If it should die,
- # and the process spawned by systemu is still alive,
- # fire off a blocking waitpid and wait for the process to
- # finish so that we can avoid zombies.
+
thread = Thread.current
+ # Start a double fork and exec with systemu which implies a guard thread.
+ # If a valid timeout is configured the guard thread will terminate the
+ # executing process and reap the pid.
+ # If no timeout is specified the process will run to completion with the
+ # guard thread reaping the pid on completion.
@status = systemu(@command, opts) do |cid|
begin
- while(thread.alive?)
- sleep 0.1
+ if timeout.is_a?(Fixnum)
+ # wait for the specified timeout
+ sleep timeout
+ else
+ # sleep while the agent thread is still alive
+ while(thread.alive?)
+ sleep 0.1
+ end
end
- Process.waitpid(cid) if Process.getpgid(cid)
+ # if the process is still running
+ if (Process.kill(0, cid))
+ # and a timeout was specified
+ if timeout
+ if Util.windows?
+ Process.kill('KILL', cid)
+ else
+ # Kill the process
+ Process.kill('TERM', cid)
+ sleep 2
+ Process.kill('KILL', cid) if (Process.kill(0, cid))
+ end
+ end
+ # only wait if the parent thread is dead
+ Process.waitpid(cid) unless thread.alive?
+ end
rescue SystemExit
rescue Errno::ESRCH
rescue Errno::ECHILD
+ Log.warn("Could not reap process '#{cid}'.")
rescue Exception => e
Log.info("Unexpected exception received while waiting for child process: #{e.class}: #{e}")
end
end
+ @status.thread.kill
+ @status
end
end
end
+++ /dev/null
-.DS_Store
-test/rails/fixtures
-nbproject/
-vendor/**/*
-*.swp
-pkg
-.bundle
-.rvmrc
+++ /dev/null
-rvm:
- - 1.8.7
- - 1.9.2
- - 1.9.3
- - ree
- - rbx
- - jruby
+++ /dev/null
-.*.sw[pon]
-coverage
-pkg
-.nfs.*
-.idea
-java/Json.iml
-Gemfile.lock
-.rvmrc
+++ /dev/null
-# Passes arguments to bundle install (http://gembundler.com/man/bundle-install.1.html)
-bundler_args: --binstubs
-
-# Specify which ruby versions you wish to run your tests on, each version will be used
-rvm:
- - 1.8.7
- - 1.9.2
- - 1.9.3
- - rbx
- - rbx-2.0
- - ree
- - jruby
- - ruby-head
-
-script: "bundle exec rake"
#
# mcollective Application Server for STOMP based agents
#
+# chkconfig: 345 24 76
#
# description: mcollective lets you build powerful Stomp compatible middleware clients in ruby without having to worry too
# much about all the setup and management of a Stomp connection, it also provides stats, logging and so forth
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Start daemon at boot time
-# Description: Enable service provided by mcollective.
+# Description: Enable service provided by daemon.
### END INIT INFO
-# check permissions
+mcollectived="/usr/sbin/mcollectived"
-uid=`id -u`
-[ $uid -gt 0 ] && { echo "You need to be root to run file" ; exit 4 ; }
+# Lockfile
+if [ -d /var/lock/subsys ]; then
+ # RedHat/CentOS/etc who use subsys
+ lock="/var/lock/subsys/mcollective"
+else
+ # The rest of them
+ lock="/var/lock/mcollective"
+fi
# PID directory
pidfile="/var/run/mcollectived.pid"
-name="mcollective"
-mcollectived=/usr/sbin/mcollectived
-daemonopts="--pid=${pidfile} --config=/etc/mcollective/server.cfg"
-
-
# Source function library.
. /lib/lsb/init-functions
if ! [ -f $mcollectived ]
then
echo "mcollectived binary not found"
- exit 5
+ exit 0
fi
-# create pid file if it does not exist
-[ ! -f ${pidfile} ] && { touch ${pidfile} ; }
-
# See how we were called.
case "$1" in
start)
- echo "Starting daemon: " $name
- # start the program
- start-stop-daemon -S -p ${pidfile} --oknodo -q -a ${mcollectived} -- ${daemonopts}
- [ $? = 0 ] && { exit 0 ; } || { exit 1 ; }
- log_success_msg "mcollective started"
- touch $lock
+ echo -n "Starting mcollective: "
+
+ if [ -f ${lock} ]; then
+ # we were not shut down correctly
+ if [ -s ${pidfile} ]; then
+ kill `cat ${pidfile}` >/dev/null 2>&1
+ fi
+ rm -f ${pidfile}
+
+ rm -f ${lock}
+ sleep 2
+ fi
+
+ rm -f ${pidfile}
+
+ ${mcollectived} --pid=${pidfile} --config="/etc/mcollective/server.cfg"
+ if [ $? = 0 ]; then
+ log_success_msg
+ touch $lock
+ exit 0
+ else
+ log_failure_msg
+ exit 1
+ fi
;;
stop)
- echo "Stopping daemon: " $name
- start-stop-daemon -K -R 5 -s "TERM" --oknodo -q -p ${pidfile}
- [ $? = 0 ] && { exit 0 ; } || { exit 1 ; }
- log_success_msg "mcollective stopped"
+ echo -n "Shutting down mcollective: "
+
+ if [ -s ${pidfile} ]; then
+ kill `cat ${pidfile}` >/dev/null 2>&1
+ fi
+ rm -f ${pidfile}
+
+ log_success_msg
+ rm -f $lock
;;
restart)
- echo "Restarting daemon: " $name
$0 stop
sleep 2
$0 start
- [ $? = 0 ] && { echo "mcollective restarted" ; exit 0 ; }
;;
condrestart)
if [ -f $lock ]; then
fi
;;
status)
- status_of_proc -p ${pidfile} ${mcollectived} ${name} && exit 0 || exit $?
+ if [ -f ${lock} ]; then
+ if [ -s ${pidfile} ]; then
+ if [ -e /proc/`cat ${pidfile}` ]; then
+ echo "mcollectived (`cat ${pidfile}`) is running"
+ exit 0
+ else
+ echo "mcollectived (`cat ${pidfile}`) is NOT running"
+ exit 1
+ fi
+ fi
+ else
+ echo "mcollectived: service not started"
+ exit 1
+ fi
+ ;;
+ force-reload)
+ echo "not implemented"
;;
*)
echo "Usage: mcollectived {start|stop|restart|condrestart|status}"
- exit 2
+ exit 1
;;
esac
+exit 0
:type => Array
option :keep_artifacts,
- :dsecription => "Don't remove artifacts after building packages",
+ :description => "Don't remove artifacts after building packages",
:arguments => ['--keep-artifacts'],
:type => :boolean
+ option :module_template,
+ :description => "Path to the template used by the modulepackager",
+ :arguments => ['--module-template PATH'],
+ :type => String
+
# Handle alternative format that optparser can't parse.
def post_option_parser(configuration)
if ARGV.length >= 1
plugin = prepare_plugin
(configuration[:pluginpath] = configuration[:pluginpath] + "/") if (configuration[:pluginpath] && !configuration[:pluginpath].match(/^.*\/$/))
packager = PluginPackager["#{configuration[:format].capitalize}Packager"]
- packager.new(plugin, configuration[:pluginpath], configuration[:sign], options[:verbose], configuration[:keep_artifacts]).create_packages
+ packager.new(plugin, configuration[:pluginpath], configuration[:sign],
+ options[:verbose], configuration[:keep_artifacts],
+ configuration[:module_template]).create_packages
end
# Agents are just called 'agent' but newer plugin types are
class DebpackagePackager
require 'erb'
- def initialize(plugin, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = nil)
+ def initialize(plugin, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = nil, module_template = nil)
if PluginPackager.command_available?('debuild')
@plugin = plugin
@verbose = verbose
--- /dev/null
+module MCollective
+ module PluginPackager
+ class ModulepackagePackager
+ require 'erb'
+
+ def initialize(plugin, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = nil, module_template = nil)
+ assert_new_enough_puppet
+ @plugin = plugin
+ @package_name = "#{@plugin.mcname}_#{@plugin.metadata[:name]}".gsub(/-/, '_')
+ @verbose = verbose
+ @keep_artifacts = keep_artifacts
+ @module_template = module_template || File.join(File.dirname(__FILE__), 'templates', 'module')
+ end
+
+ # Build Process :
+ # - create module directory
+ # - run 'puppet module build'
+ # - move generated package back to cwd
+ def create_packages
+ begin
+ puts "Building module for #{@package_name} plugin."
+
+ @tmpdir = Dir.mktmpdir('mcollective_packager')
+ make_module
+ run_build
+ move_package
+
+ puts "Completed building module for #{@package_name} plugin."
+ ensure
+ if @keep_artifacts
+ puts 'Keeping build artifacts'
+ puts "Build artifacts saved - #{@tmpdir}"
+ else
+ cleanup_tmpdirs
+ end
+ end
+ end
+
+ private
+
+ def assert_new_enough_puppet
+ unless PluginPackager.command_available?('puppet')
+ raise("Cannot build package. 'puppet' is not present on the system.")
+ end
+
+ s = Shell.new('puppet --version')
+ s.runcommand
+ actual_version = s.stdout.chomp
+
+ required_version = '3.3.0'
+ if Util.versioncmp(actual_version, required_version) < 0
+ raise("Cannot build package. puppet #{required_version} or greater required. We have #{actual_version}.")
+ end
+ end
+
+ def make_module
+ targetdir = File.join(@tmpdir, 'manifests')
+ FileUtils.mkdir_p(targetdir) unless File.directory?(targetdir)
+
+ # for each subpackage make a subclass
+ @plugin.packagedata.each do |klass,data|
+ data[:files].each do |file|
+ relative_path = file.sub(/^\.\//, '')
+ targetdir = File.join(@tmpdir, 'files', klass.to_s, 'mcollective', File.dirname(relative_path))
+ FileUtils.mkdir_p(targetdir) unless File.directory?(targetdir)
+ FileUtils.cp_r(file, targetdir)
+ end
+
+ @klass = klass.to_s
+ render_template('_manifest.pp.erb', File.join(@tmpdir, 'manifests', "#{klass}.pp"))
+ end
+
+ # render all the templates we have
+ Dir.glob(File.join(@module_template, '*.erb')).each do |template|
+ filename = File.basename(template, '.erb')
+ next if filename =~ /^_/ # starting with underscore makes it private
+ render_template("#{filename}.erb", File.join(@tmpdir, filename))
+ end
+ end
+
+ def render_template(template, path)
+ begin
+ erb = ERB.new(File.read(File.join(@module_template, template)), nil, '-')
+ File.open(path, 'w') do |f|
+ f.puts erb.result(binding)
+ end
+ rescue => e
+ puts "Could not render template to path - '#{path}'"
+ raise e
+ end
+ end
+
+ def run_build
+ begin
+ PluginPackager.execute_verbosely(@verbose) do
+ Dir.chdir(@tmpdir) do
+ PluginPackager.safe_system('puppet module build')
+ end
+ end
+ rescue => e
+ puts 'Build process has failed'
+ raise e
+ end
+ end
+
+ # Move built package to cwd
+ def move_package
+ begin
+ package_file = File.join(@tmpdir, 'pkg', "#{@plugin.vendor}-#{@package_name}-#{@plugin.metadata[:version]}.tar.gz")
+ FileUtils.cp(package_file, '.')
+ rescue => e
+ puts 'Could not copy package to working directory'
+ raise e
+ end
+ end
+
+ def cleanup_tmpdirs
+ begin
+ FileUtils.rm_r(@tmpdir) if File.directory?(@tmpdir)
+ rescue => e
+ puts "Could not remove temporary build directory - '#{@tmpdir}'"
+ raise e
+ end
+ end
+ end
+ end
+end
# Create packager object with package parameter containing list of files,
# dependencies and package metadata.
- def initialize(package, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = false)
+ def initialize(package, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = false, module_template = nil)
if File.exists?("/etc/redhat-release")
- @packager = PluginPackager["RpmpackagePackager"].new(package, pluginpath, signature, verbose, keep_artifacts)
+ @packager = PluginPackager["RpmpackagePackager"].new(package, pluginpath, signature, verbose, keep_artifacts, module_template)
@package_type = "RPM"
elsif File.exists?("/etc/debian_version")
- @packager = PluginPackager["DebpackagePackager"].new(package, pluginpath, signature, verbose, keep_artifacts)
+ @packager = PluginPackager["DebpackagePackager"].new(package, pluginpath, signature, verbose, keep_artifacts, module_template)
@package_type = "Deb"
else
raise "cannot identify operating system."
class RpmpackagePackager
require 'erb'
- def initialize(plugin, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = nil)
+ def initialize(plugin, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = nil, module_template = nil)
if @buildtool = select_command
@plugin = plugin
@package_name = "#{@plugin.mcname}-#{@plugin.metadata[:name]}"
--- /dev/null
+name '<%= @plugin.vendor %>-<%= @package_name %>'
+version '<%= @plugin.metadata[:version] %>'
+description '<%= @plugin.metadata[:description] %>'
+project_page '<%= @plugin.metadata[:url]%>'
+dependency 'puppetlabs/mcollective', '1.x'
--- /dev/null
+# <%= @package_name %>
+
+#### Table of Contents
+
+1. [Overview](#overview)
+2. [Module Description - What the module does and why it is useful](#module-description)
+3. [Setup - The basics of getting started with <%= @package_name %>](#setup)
+ * [What the <%= @package_name %> module affects](#what-the-<%= @package_name %>-module-affects)
+ * [Setup requirements](#setup-requirements)
+4. [Usage - Configuration options and additional functionality](#usage)
+5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
+
+
+## Overview
+
+The <%= @package_name %> module is a module that wraps a source release of the
+<%= @plugin.metadata[:name] %> mcollective plugin for use with the
+[puppetlabs mcollective](http://forge.puppetlabs.com/puppetlabs/mcollective)
+module.
+
+## Module description
+
+## Usage
+
+<% @plugin.packagedata.keys.map { |x| x.to_s }.sort.each do |klass| -%>
+<%# Don't document common class -%>
+<% if klass != "common" -%>
+### class <%= @package_name %>::<%= klass %>
+
+Installs the <%= klass %> component of the <%= @plugin.metadata[:name] %> plugin.
+
+```puppet
+include <%= @package_name%>::<%= klass %>
+```
+<% end %>
+<% end %>
+
--- /dev/null
+#
+class <%= @package_name %>::<%= @klass %> {
+ <% if @plugin.packagedata[:common] && @klass != 'common' %>
+ include ::<%= @package_name %>::common
+ <% end %>
+ mcollective::plugin { '<%= @package_name %>/<%= @klass %>':
+ source => 'puppet:///modules/<%= @package_name %>/<% @klass %>',
+ }
+}
Code Review / packages / precise / mcollective.git / commitdiff
