Class: Puppet::DataProviders::FunctionEnvDataProvider Deprecated Private

Inherits:

Plugins::DataProviders::EnvironmentDataProvider

• Object
• Plugins::DataProviders::EnvironmentDataProvider
• Puppet::DataProviders::FunctionEnvDataProvider

Includes:

DataFunctionSupport

Defined in:

lib/puppet/data_providers/function_env_data_provider.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.

Deprecated.

The FunctionEnvDataProvider provides data from a function called ‘environment::data()’ that resides in a directory environment (seen as a module with the name environment). The function is called on demand, and is associated with the compiler via an Adapter. This ensures that the data is only produced once per compilation.

TODO: API 5.0, remove this class

Constant Summary

Constants included from Pops::Lookup::SubLookup

Pops::Lookup::SubLookup::SPECIAL

Instance Method Summary

• #loader(key, scope) ⇒ Object private

Methods included from DataFunctionSupport

#initialize_data

Methods inherited from Plugins::DataProviders::EnvironmentDataProvider

#data_key, #initialize

Methods included from Plugins::DataProviders::DataProvider

#data_key, #key_lookup, #lookup, #name, #post_process, #unchecked_key_lookup, #unchecked_lookup, #validate_data

Methods included from Pops::Lookup::Interpolation

#interpolate

Methods included from Pops::Lookup::SubLookup

#split_key, #sub_lookup

Methods included from Pops::Lookup::DataProvider

#key_lookup, #key_lookup_in_default, key_type, #lookup, #module_name, #name, register_types, #unchecked_key_lookup, #validate_data_hash, #validate_data_value, #value_is_validated?, value_type

Constructor Details

This class inherits a constructor from Puppet::Plugins::DataProviders::EnvironmentDataProvider

Instance Method Details

#loader(key, scope) ⇒ 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.

# File 'lib/puppet/data_providers/function_env_data_provider.rb', line 17

def loader(key, scope)
  unless Puppet[:strict] == :off
    Puppet.warn_once(:deprecation, 'Puppet::DataProviders::FunctionEnvDataProvider',
      'Puppet::DataProviders::FunctionEnvDataProvider is deprecated and will be removed in the next major version of Puppet')
  end

  # This loader allows the data function to be private or public in the environment
  scope.compiler.loaders.private_environment_loader
end