Class: Puppet::Environments::Cached Private

Inherits:
Object
  • Object
show all
Includes:
EnvironmentLoader
Defined in:
lib/puppet/environments.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Defined Under Namespace

Classes: DefaultCacheExpirationService, Entry, NotCachedEntry, TTLEntry

Constant Summary collapse

INFINITY =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

1.0 / 0.0

Class Method Summary collapse

Instance Method Summary collapse

Methods included from EnvironmentLoader

#get!

Constructor Details

#initialize(loader) ⇒ Cached

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Cached.



341
342
343
344
345
 
# File 'lib/puppet/environments.rb', line 341

def initialize(loader)
  @loader = loader
  @cache = {}
  @cache_expiration_service = Puppet::Environments::Cached.cache_expiration_service
end

Class Method Details

.cache_expiration_service ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



337
338
339
 
# File 'lib/puppet/environments.rb', line 337

def self.cache_expiration_service
  @cache_expiration_service || DefaultCacheExpirationService.new
end

.cache_expiration_service=(service) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



333
334
335
 
# File 'lib/puppet/environments.rb', line 333

def self.cache_expiration_service=(service)
  @cache_expiration_service = service
end

Instance Method Details

#clear(name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Clears the cache of the environment with the given name. (The intention is that this could be used from a MANUAL cache eviction command (TBD)



370
371
372
 
# File 'lib/puppet/environments.rb', line 370

def clear(name)
  @cache.delete(name)
end

#clear_all ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Clears all cached environments. (The intention is that this could be used from a MANUAL cache eviction command (TBD)



376
377
378
 
# File 'lib/puppet/environments.rb', line 376

def clear_all()
  @cache = {}
end

#entry(env) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Creates a suitable cache entry given the time to live for one environment



395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/puppet/environments.rb', line 395

def entry(env)
  @cache_expiration_service.created(env)
  ttl = (conf = get_conf(env.name)) ? conf.environment_timeout : Puppet.settings.value(:environment_timeout)
  case ttl
  when 0
    NotCachedEntry.new(env)     # Entry that is always expired (avoids syscall to get time)
  when INFINITY
    Entry.new(env)              # Entry that never expires (avoids syscall to get time)
  else
    TTLEntry.new(env, ttl)
  end
end

#evict_if_expired(name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Evicts the entry if it has expired Also clears caches in Settings that may prevent the entry from being updated



410
411
412
413
414
415
416
417
 
# File 'lib/puppet/environments.rb', line 410

def evict_if_expired(name)
  if (result = @cache[name]) && (result.expired? || @cache_expiration_service.expired?(name))
    @cache.delete(name)
    @cache_expiration_service.evicted(name)

    Puppet.settings.clear_environment_settings(name)
  end
end

#get(name) ⇒ Puppet::Node::Environment?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Find a named environment

Parameters:

Returns:



358
359
360
361
362
363
364
365
366
 
# File 'lib/puppet/environments.rb', line 358

def get(name)
  evict_if_expired(name)
  if result = @cache[name]
    return result.value
  elsif (result = @loader.get(name))
    @cache[name] = entry(result)
    result
  end
end

#get_conf(name) ⇒ Puppet::Setting::EnvironmentConf?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This implementation evicts the cache, and always gets the current configuration of the environment

TODO: While this is wasteful since it needs to go on a search for the conf, it is too disruptive to optimize this.

Attempt to obtain the initial configuration for the environment. Not all loaders can provide this.

Parameters:

  • name (String, Symbol) —

    The name of the environment whose configuration we are looking up

Returns:

  • (Puppet::Setting::EnvironmentConf, nil) —

    the configuration for the requested environment, or nil if not found or no configuration is available



388
389
390
391
 
# File 'lib/puppet/environments.rb', line 388

def get_conf(name)
  evict_if_expired(name)
  @loader.get_conf(name)
end

#list ⇒ Array<Puppet::Node::Environment>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns All of the environments known to the loader.

Returns:



348
349
350
 
# File 'lib/puppet/environments.rb', line 348

def list
  @loader.list
end

#search_paths ⇒ Array<String>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

A list of indicators of where the loader is getting its environments from.

Returns:



353
354
355
 
# File 'lib/puppet/environments.rb', line 353

def search_paths
  @loader.search_paths
end