Class: Puppet::Environments::Combined Private

Inherits:
Object
  • Object
show all
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.

Direct Known Subclasses

Cached

Instance Method Summary collapse

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.



230
231
232
 
# File 'lib/puppet/environments.rb', line 230

def initialize(*loaders)
  @loaders = loaders
end

Instance Method Details

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



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

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



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

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:



240
241
242
 
# File 'lib/puppet/environments.rb', line 240

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:



235
236
237
 
# File 'lib/puppet/environments.rb', line 235

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