Class: MCollective::Generators::AgentGenerator

### Home Classes Methods

### In Files

- lib/mcollective/generators/agent_generator.rb

### Parent

MCollective::Generators::Base

### Methods

- ::new
- #action_help
- #create_ddl
- #create_plugin_content

### Files

- COPYING
- README
- Rakefile
- PLACEHOLDER
- PLACEHOLDER

### Class/Module Index

Quicksearch

- MCollective
- MCollective::Agent
- MCollective::Agents
- MCollective::Aggregate
- MCollective::Aggregate::Base
- MCollective::Aggregate::Result
- MCollective::Aggregate::Result::Base
- MCollective::Aggregate::Result::CollectionResult
- MCollective::Aggregate::Result::NumericResult
- MCollective::Application
- MCollective::Applications
- MCollective::Client
- MCollective::Config
- MCollective::Connector
- MCollective::Connector::Base
- MCollective::DDL
- MCollective::DDLValidationError
- MCollective::Data
- MCollective::Data::Base
- MCollective::Data::Result
- MCollective::Discovery
- MCollective::Facts
- MCollective::Facts::Base
- MCollective::Generators
- MCollective::Generators::AgentGenerator
- MCollective::Generators::Base
- MCollective::Generators::DataGenerator
- MCollective::InvalidRPCData
- MCollective::Log
- MCollective::Logger
- MCollective::Logger::Base
- MCollective::Logger::Console_logger
- MCollective::Logger::File_logger
- MCollective::Logger::Syslog_logger
- MCollective::Matcher
- MCollective::Matcher::Parser
- MCollective::Matcher::Scanner
- MCollective::Message
- MCollective::MissingRPCData
- MCollective::MsgDoesNotMatchRequestID
- MCollective::MsgTTLExpired
- MCollective::NotTargettedAtUs
- MCollective::Optionparser
- MCollective::PluginManager
- MCollective::PluginPackager
- MCollective::PluginPackager::AgentDefinition
- MCollective::PluginPackager::StandardDefinition
- MCollective::RPC
- MCollective::RPC::ActionRunner
- MCollective::RPC::Agent
- MCollective::RPC::Audit
- MCollective::RPC::Client
- MCollective::RPC::Helpers
- MCollective::RPC::Progress
- MCollective::RPC::Reply
- MCollective::RPC::Request
- MCollective::RPC::Result
- MCollective::RPC::Stats
- MCollective::RPCAborted
- MCollective::RPCError
- MCollective::Registration
- MCollective::Registration::Base
- MCollective::Runner
- MCollective::RunnerStats
- MCollective::SSL
- MCollective::Security
- MCollective::Security::Base
- MCollective::SecurityValidationFailed
- MCollective::Shell
- MCollective::UnixDaemon
- MCollective::UnknownRPCAction
- MCollective::UnknownRPCError
- MCollective::Util
- MCollective::WindowsDaemon
- Array
- Dir
- Object
- String
- Symbol

No matching classes.

# MCollective::Generators::AgentGenerator

### Attributes

content[RW]
ddl[RW]

### Public Instance Methods

action_help() click to toggle source

    # File lib/mcollective/generators/agent_generator.rb, line 45
    def action_help
      action_snippet = File.read(File.join(File.dirname(__FILE__), "templates", "action_snippet.erb"))
      ERB.new(action_snippet).result
    end

create_ddl() click to toggle source

    # File lib/mcollective/generators/agent_generator.rb, line 21
    def create_ddl
      action_text = ""
      @actions.each_with_index do |action, i|
        action_text += "action \"#{action}\", :description => \"%ACTIONDESCRIPTION%\" do\n"
        action_text += action_help if i == 0
        action_text += "end\n"
        action_text += "\n" unless @actions.size == (i + 1)
      end
      # Use inherited method to create metadata part of the ddl
      create_metadata_string + action_text
    end

create_plugin_content() click to toggle source

    # File lib/mcollective/generators/agent_generator.rb, line 33
    def create_plugin_content
      content_text = ""

      # Add actions to agent file
      @actions.each_with_index do |action, i|
        content_text +=  "%6s%s" % [" ", "action \"#{action}\" do\n"]
        content_text +=  "%6s%s" % [" ", "end\n"]
        content_text += "\n" unless @actions.size == (i + 1)
      end
      content_text
    end

### Public Class Methods

new(plugin_name, actions = [], name = nil, description = nil, author = nil , license = nil, version = nil, url = nil, timeout = nil) click to toggle source

    # File lib/mcollective/generators/agent_generator.rb, line 7
    def initialize(plugin_name, actions = [],  name = nil, description = nil, author = nil ,
                   license = nil, version = nil, url = nil, timeout = nil)

      super(name, description, author, license, version, url, timeout)
      @plugin_name = plugin_name
      @actions = actions || []
      @ddl = create_ddl
      @mod_name = "Agent"
      @pclass = "RPC::Agent"
      @content = create_plugin_content
      @plugin = create_plugin_string
      write_plugins
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.