Class: Puppet::Indirector::Indirection

Inherits:
Object
  • Object
show all
Includes:
Util::Docs
Defined in:
lib/puppet/indirector/indirection.rb

Overview

The class that connects functional classes with their different collection back-ends. Each indirection has a set of associated terminus classes, each of which is a subclass of Puppet::Indirector::Terminus.

Constant Summary collapse

@@indirections = 
[]

Constants included from Util::Docs

Util::Docs::HEADER_LEVELS

Instance Attribute Summary collapse

Attributes included from Util::Docs

#nodoc

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util::Docs

#desc, #dochook, #doctable, #markdown_definitionlist, #markdown_header, #nodoc?, #pad, scrub

Constructor Details

#initialize(model, name, doc: nil, indirected_class: nil, cache_class: nil, terminus_class: nil, terminus_setting: nil, extend: nil) ⇒ Indirection

Returns a new instance of Indirection.

Raises:

  • (ArgumentError) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/puppet/indirector/indirection.rb', line 90

def initialize(model, name, doc: nil, indirected_class: nil, cache_class: nil, terminus_class: nil, terminus_setting: nil, extend: nil)
  @model = model
  @name = name
  @termini = {}

  @doc = doc

  raise(ArgumentError, _("Indirection %{name} is already defined") % { name: @name }) if @@indirections.find { |i| i.name == @name }
  @@indirections << self

  @indirected_class = indirected_class
  self.extend(extend) if extend

  # These setters depend on the indirection already being installed so they have to be at the end
  self.cache_class = cache_class if cache_class
  self.terminus_class = terminus_class if terminus_class
  self.terminus_setting = terminus_setting if terminus_setting
end

Instance Attribute Details

#cache_class ⇒ Object

Returns the value of attribute cache_class.



47
48
49
 
# File 'lib/puppet/indirector/indirection.rb', line 47

def cache_class
  @cache_class
end

#model ⇒ Object

Returns the value of attribute model.



12
13
14
 
# File 'lib/puppet/indirector/indirection.rb', line 12

def model
  @model
end

#name ⇒ Object

Returns the value of attribute name.



12
13
14
 
# File 'lib/puppet/indirector/indirection.rb', line 12

def name
  @name
end

#termini ⇒ Object (readonly)

Returns the value of attribute termini.



13
14
15
 
# File 'lib/puppet/indirector/indirection.rb', line 13

def termini
  @termini
end

#terminus_setting ⇒ Object

This can be used to select the terminus class.



123
124
125
 
# File 'lib/puppet/indirector/indirection.rb', line 123

def terminus_setting
  @terminus_setting
end

Class Method Details

.instance(name) ⇒ Object

Find an indirection by name. This is provided so that Terminus classes can specifically hook up with the indirections they are associated with.



19
20
21
 
# File 'lib/puppet/indirector/indirection.rb', line 19

def self.instance(name)
  @@indirections.find { |i| i.name == name }
end

.instances ⇒ Object

Return a list of all known indirections. Used to generate the reference.



25
26
27
 
# File 'lib/puppet/indirector/indirection.rb', line 25

def self.instances
  @@indirections.collect { |i| i.name }
end

.model(name) ⇒ Object

Find an indirected model by name. This is provided so that Terminus classes can specifically hook up with the indirections they are associated with.



31
32
33
34
 
# File 'lib/puppet/indirector/indirection.rb', line 31

def self.model(name)
  return nil unless match = @@indirections.find { |i| i.name == name }
  match.model
end

Instance Method Details

#allow_remote_requests? ⇒ Boolean

Returns:

  • (Boolean) 


176
177
178
 
# File 'lib/puppet/indirector/indirection.rb', line 176

def allow_remote_requests?
  terminus.allow_remote_requests?
end

#cache ⇒ Object

Create and return our cache terminus.

Raises:



37
38
39
40
 
# File 'lib/puppet/indirector/indirection.rb', line 37

def cache
  raise Puppet::DevError, _("Tried to cache when no cache class was set") unless cache_class
  terminus(cache_class)
end

#cache? ⇒ Boolean

Should we use a cache?

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/puppet/indirector/indirection.rb', line 43

def cache?
  cache_class ? true : false
end

#delete ⇒ Object

This is only used for testing.



55
56
57
 
# File 'lib/puppet/indirector/indirection.rb', line 55

def delete
  @@indirections.delete(self) if @@indirections.include?(self)
end

#destroy(key, options = {}) ⇒ Object

Remove something via the terminus.



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/puppet/indirector/indirection.rb', line 250

def destroy(key, options={})
  request = request(:destroy, key, nil, options)
  terminus = prepare(request)

  result = terminus.destroy(request)

  if cache? and cache.find(request(:find, key, nil, options))
    # Reuse the existing request, since it's equivalent.
    cache.destroy(request)
  end

  result
end

#doc ⇒ Object

Generate the full doc string.



77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/puppet/indirector/indirection.rb', line 77

def doc
  text = ""

  text << scrub(@doc) << "\n\n" if @doc

  text << "* **Indirected Class**: `#{@indirected_class}`\n";
  if terminus_setting
    text << "* **Terminus Setting**: #{terminus_setting}\n"
  end

  text
end

#expiration ⇒ Object

Calculate the expiration date for a returned instance.



72
73
74
 
# File 'lib/puppet/indirector/indirection.rb', line 72

def expiration
  Time.now + ttl
end

#expire(key, options = {}) ⇒ Object

Expire a cached object, if one is cached. Note that we don’t actually remove it, we expire it and write it back out to disk. This way people can still use the expired object if they want.



161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/puppet/indirector/indirection.rb', line 161

def expire(key, options={})
  request = request(:expire, key, nil, options)

  return nil unless cache? && !request.ignore_cache_save?

  return nil unless instance = cache.find(request(:find, key, nil, options))

  Puppet.info _("Expiring the %{cache} cache of %{instance}") % { cache: self.name, instance: instance.name }

  # Set an expiration date in the past
  instance.expiration = Time.now - 60

  cache.save(request(:save, nil, instance, options))
end

#find(key, options = {}) ⇒ Object

Search for an instance in the appropriate terminus, caching the results if caching is configured..



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/puppet/indirector/indirection.rb', line 182

def find(key, options={})
  request = request(:find, key, nil, options)
  terminus = prepare(request)

  result = find_in_cache(request)
  if not result.nil?
    result
  elsif request.ignore_terminus?
    nil
  else
    # Otherwise, return the result from the terminus, caching if
    # appropriate.
    result = terminus.find(request)
    if not result.nil?
      result.expiration ||= self.expiration if result.respond_to?(:expiration)
      if cache? && !request.ignore_cache_save?
        Puppet.info _("Caching %{indirection} for %{request}") % { indirection: self.name, request: request.key }
        begin
          cache.save request(:save, key, result, options)
        rescue => detail
          Puppet.log_exception(detail)
          raise detail
        end
      end

      filtered = result
      if terminus.respond_to?(:filter)
        Puppet::Util::Profiler.profile(_("Filtered result for %{indirection} %{request}") % { indirection: self.name, request: request.key }, [:indirector, :filter, self.name, request.key]) do
          begin
            filtered = terminus.filter(result)
          rescue Puppet::Error => detail
            Puppet.log_exception(detail)
            raise detail
          end
        end
      end
      filtered
    end
  end
end

#find_in_cache(request) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/puppet/indirector/indirection.rb', line 234

def find_in_cache(request)
  # See if our instance is in the cache and up to date.
  return nil unless cache? and ! request.ignore_cache? and cached = cache.find(request)
  if cached.expired?
    Puppet.info _("Not using expired %{indirection} for %{request} from cache; expired at %{expiration}") % { indirection: self.name, request: request.key, expiration: cached.expiration }
    return nil
  end

  Puppet.debug "Using cached #{self.name} for #{request.key}"
  cached
rescue => detail
  Puppet.log_exception(detail, _("Cached %{indirection} for %{request} failed: %{detail}") % { indirection: self.name, request: request.key, detail: detail })
  nil
end

#head(key, options = {}) ⇒ Object

Search for an instance in the appropriate terminus, and return a boolean indicating whether the instance was found.



225
226
227
228
229
230
231
232
 
# File 'lib/puppet/indirector/indirection.rb', line 225

def head(key, options={})
  request = request(:head, key, nil, options)
  terminus = prepare(request)

  # Look in the cache first, then in the terminus.  Force the result
  # to be a boolean.
  !!(find_in_cache(request) || terminus.head(request))
end

#request(*args) ⇒ Object

Set up our request object.



110
111
112
 
# File 'lib/puppet/indirector/indirection.rb', line 110

def request(*args)
  Puppet::Indirector::Request.new(self.name, *args)
end

#reset_terminus_class ⇒ Object 



137
138
139
 
# File 'lib/puppet/indirector/indirection.rb', line 137

def reset_terminus_class
  @terminus_class = nil
end

#save(instance, key = nil, options = {}) ⇒ Object

Save the instance in the appropriate terminus. This method is normally an instance method on the indirected class.



281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/puppet/indirector/indirection.rb', line 281

def save(instance, key = nil, options={})
  request = request(:save, key, instance, options)
  terminus = prepare(request)

  result = terminus.save(request)

  # If caching is enabled, save our document there
  cache.save(request) if cache? && !request.ignore_cache_save?

  result
end

#search(key, options = {}) ⇒ Object

Search for more than one instance. Should always return an array.



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/puppet/indirector/indirection.rb', line 265

def search(key, options={})
  request = request(:search, key, nil, options)
  terminus = prepare(request)

  if result = terminus.search(request)
    raise Puppet::DevError, _("Search results from terminus %{terminus_name} are not an array") % { terminus_name: terminus.name } unless result.is_a?(Array)
    result.each do |instance|
      next unless instance.respond_to? :expiration
      instance.expiration ||= self.expiration
    end
    return result
  end
end

#terminus(terminus_name = nil) ⇒ Object

Return the singleton terminus for this indirection.

Raises:



115
116
117
118
119
120
 
# File 'lib/puppet/indirector/indirection.rb', line 115

def terminus(terminus_name = nil)
  # Get the name of the terminus.
  raise Puppet::DevError, _("No terminus specified for %{name}; cannot redirect") % { name: self.name } unless terminus_name ||= terminus_class

  termini[terminus_name] ||= make_terminus(terminus_name)
end

#terminus_class ⇒ Object

Determine the terminus class.



126
127
128
129
130
131
132
133
134
135
 
# File 'lib/puppet/indirector/indirection.rb', line 126

def terminus_class
  unless @terminus_class
    if setting = self.terminus_setting
      self.terminus_class = Puppet.settings[setting]
    else
      raise Puppet::DevError, _("No terminus class nor terminus setting was provided for indirection %{name}") % { name: self.name}
    end
  end
  @terminus_class
end

#terminus_class=(klass) ⇒ Object

Specify the terminus class to use.



142
143
144
145
 
# File 'lib/puppet/indirector/indirection.rb', line 142

def terminus_class=(klass)
  validate_terminus_class(klass)
  @terminus_class = klass
end

#ttl ⇒ Object

Default to the runinterval for the ttl.



67
68
69
 
# File 'lib/puppet/indirector/indirection.rb', line 67

def ttl
  @ttl ||= Puppet[:runinterval]
end

#ttl=(value) ⇒ Object

Set the time-to-live for instances created through this indirection.

Raises:

  • (ArgumentError) 


60
61
62
63
64
 
# File 'lib/puppet/indirector/indirection.rb', line 60

def ttl=(value)
  #TRANSLATORS "TTL" stands for "time to live" and refers to a duration of time
  raise ArgumentError, _("Indirection TTL must be an integer") unless value.is_a?(Integer)
  @ttl = value
end

#validate_terminus_class(terminus_class) ⇒ Object

This is used by terminus_class= and cache=.



148
149
150
151
152
153
154
155
156
 
# File 'lib/puppet/indirector/indirection.rb', line 148

def validate_terminus_class(terminus_class)
  unless terminus_class and terminus_class.to_s != ""
    raise ArgumentError, _("Invalid terminus name %{terminus_class}") % { terminus_class: terminus_class.inspect }
  end
  unless Puppet::Indirector::Terminus.terminus_class(self.name, terminus_class)
    raise ArgumentError, _("Could not find terminus %{terminus_class} for indirection %{name}") %
        { terminus_class: terminus_class, name: self.name }
  end
end