Class: MCollective::Registration::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/mcollective/registration/base.rb

Overview

This is a base class that other registration plugins can use to handle regular announcements to the mcollective

The configuration file determines how often registration messages gets sent using the registerinterval option, the plugin runs in the background in a thread.

Direct Known Subclasses

Agentlist

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.inherited(klass) ⇒ Object

Register plugins that inherits base



11
12
13
 
# File 'lib/mcollective/registration/base.rb', line 11

def self.inherited(klass)
  PluginManager << {:type => "registration_plugin", :class => klass.to_s}
end

Instance Method Details

#body ⇒ Object 



67
68
69
 
# File 'lib/mcollective/registration/base.rb', line 67

def body
  raise "Registration Plugins must implement the #body method"
end

#config ⇒ Object 



27
28
29
 
# File 'lib/mcollective/registration/base.rb', line 27

def config
  Config.instance
end

#interval ⇒ Object 



50
51
52
 
# File 'lib/mcollective/registration/base.rb', line 50

def interval
  config.registerinterval
end

#msg_filter ⇒ Object 



31
32
33
34
35
 
# File 'lib/mcollective/registration/base.rb', line 31

def msg_filter
  filter = Util.empty_filter
  filter["agent"] << "registration"
  filter
end

#publish(message) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/mcollective/registration/base.rb', line 54

def publish(message)
  unless message
    Log.debug("Skipping registration due to nil body")
  else
    req = Message.new(message, nil, {:type => :request, :agent => "registration", :collective => target_collective, :filter => msg_filter})
    req.encode!

    Log.debug("Sending registration #{req.requestid} to collective #{req.collective}")

    req.publish
  end
end

#run(connection) ⇒ Object

Creates a background thread that periodically send a registration notice.

The actual registration notices comes from the ‘body’ method of the registration plugins.



19
20
21
22
23
24
25
 
# File 'lib/mcollective/registration/base.rb', line 19

def run(connection)
  return false if interval == 0

  Thread.new do
    publish_thread(connection)
  end
end

#target_collective ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/mcollective/registration/base.rb', line 37

def target_collective
  main_collective = config.main_collective

  collective = config.registration_collective || main_collective

  unless config.collectives.include?(collective)
    Log.warn("Sending registration to #{main_collective}: #{collective} is not a valid collective")
    collective = main_collective
  end

  return collective
end