Class MCollective::DDL::Base
In: lib/mcollective/ddl/base.rb
Parent: Object

The base class for all kinds of DDL files. DDL files when run gets parsed and builds up a hash of the basic primitive types, ideally restricted so it can be converted to JSON though today there are some Ruby Symbols in them which might be fixed laster on.

The Hash being built should be stored in @entities, the format is generally not prescribed but there‘s a definite feel to how DDL files look so study the agent and discovery ones to see how the structure applies to very different use cases.

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 ‘metadata’ in your plugin DDL then add a PlugintypeDDL class here and add your specific behaviors to those.

Methods

findddlfile   help   input   loadddlfile   metadata   new   output   requires   template_for_plugintype   usage   validate_input_argument   validate_requirements  

Attributes

entities  [R] 
meta  [R] 
pluginname  [R] 
plugintype  [R] 
requirements  [R] 
usage  [R] 

Public Class methods

Public Instance methods

help(template=nil)

Generates help using the template based on the data created with metadata and input.

If no template name is provided one will be chosen based on the plugin type. If the provided template path is not absolute then the template will be loaded either from the config dir and if that does not exist, default to /etc/mcollective

input(argument, properties)

Registers an input argument for a given action

See the documentation for action for how to use this

metadata(meta)

Registers meta data for the introspection hash

output(argument, properties)

Registers an output argument for a given action

See the documentation for action for how to use this

validate_input_argument(input, key, argument)

validate strings, lists and booleans, we‘ll add more types of validators when all the use cases are clear

only does validation for arguments actually given, since some might be optional. We validate the presense of the argument earlier so this is a safe assumption, just to skip them.

:string can have maxlength and regex. A maxlength of 0 will bypasss checks :list has a array of valid values

[Validate]