Class: Puppet::Environments::Combined Private

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

Overview

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.

Combine together multiple loaders to act as one.

Instance Method Summary collapse

Methods included from EnvironmentLoader

#get!

Constructor Details

#initialize(*loaders) ⇒ Combined

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 Combined.



232
233
234
 
# File 'lib/puppet/environments.rb', line 232

def initialize(*loaders)
  @loaders = loaders
end

Instance Method Details

#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. 



266
267
268
 
# File 'lib/puppet/environments.rb', line 266

def clear_all
  @loaders.each {|loader| loader.clear_all}
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:

  • name (String, Symbol) —

    The name of environment to find

Returns:



247
248
249
250
251
252
253
254
 
# File 'lib/puppet/environments.rb', line 247

def get(name)
  @loaders.each do |loader|
    if env = loader.get(name)
      return env
    end
  end
  nil
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.

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



257
258
259
260
261
262
263
264
 
# File 'lib/puppet/environments.rb', line 257

def get_conf(name)
  @loaders.each do |loader|
    if conf = loader.get_conf(name)
      return conf
    end
  end
  nil
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:



242
243
244
 
# File 'lib/puppet/environments.rb', line 242

def list
  @loaders.collect(&:list).flatten
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:

  • (Array<String>) —

    The URIs of the load locations



237
238
239
 
# File 'lib/puppet/environments.rb', line 237

def search_paths
  @loaders.collect(&:search_paths).flatten
end