--- /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
Code Review / packages / precise / mcollective.git / blobdiff