Module: Puppet::Network::HttpPool Deprecated

Defined in:
lib/puppet/network/http_pool.rb

Overview

Deprecated.

Use HTTP::Client instead.

This module is deprecated.

Class Method Summary collapse

Class Method Details

.connection(host, port, use_ssl: true, ssl_context: nil) ⇒ Puppet::Network::HTTP::Connection

Deprecated.

Use :http instead.

Retrieve a connection for the given host and port.

Parameters:

  • host (String)

    The host to connect to

  • port (Integer)

    The port to connect to

  • use_ssl (Boolean) (defaults to: true)

    Whether to use SSL, defaults to `true`.

  • ssl_context (Puppet::SSL:SSLContext, nil) (defaults to: nil)

    The ssl context to use when making HTTPS connections. Required when `use_ssl` is `true`.

Returns:


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/puppet/network/http_pool.rb', line 57

def self.connection(host, port, use_ssl: true, ssl_context: nil)
  Puppet.warn_once('deprecations', self, "The method 'Puppet::Network::HttpPool.connection' is deprecated. Use Puppet.runtime[:http] instead")

  if use_ssl
    unless ssl_context
      # TRANSLATORS 'ssl_context' is an argument and should not be translated
      raise ArgumentError, _("An ssl_context is required when connecting to 'https://%{host}:%{port}'") % { host: host, port: port }
    end

    verifier = Puppet::SSL::Verifier.new(host, ssl_context)
    http_client_class.new(host, port, use_ssl: true, verifier: verifier)
  else
    if ssl_context
      # TRANSLATORS 'ssl_context' is an argument and should not be translated
      Puppet.warning(_("An ssl_context is unnecessary when connecting to 'http://%{host}:%{port}' and will be ignored") % { host: host, port: port })
    end

    http_client_class.new(host, port, use_ssl: false)
  end
end

.http_client_classObject


14
15
16
# File 'lib/puppet/network/http_pool.rb', line 14

def self.http_client_class
  @http_client_class
end

.http_client_class=(klass) ⇒ Object


17
18
19
# File 'lib/puppet/network/http_pool.rb', line 17

def self.http_client_class=(klass)
  @http_client_class = klass
end

.http_instance(host, port, use_ssl = true, verify_peer = true) ⇒ Puppet::Network::HTTP::Connection

Deprecated.

Use :http instead.

Retrieve a connection for the given host and port.

Parameters:

  • host (String)

    The hostname to connect to

  • port (Integer)

    The port on the host to connect to

  • use_ssl (Boolean) (defaults to: true)

    Whether to use an SSL connection

  • verify_peer (Boolean) (defaults to: true)

    Whether to verify the peer credentials, if possible. Verification will not take place if the CA certificate is missing.

Returns:


32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/puppet/network/http_pool.rb', line 32

def self.http_instance(host, port, use_ssl = true, verify_peer = true)
  Puppet.warn_once('deprecations', self, "The method 'Puppet::Network::HttpPool.http_instance' is deprecated. Use Puppet.runtime[:http] instead")

  if verify_peer
    verifier = Puppet::SSL::Verifier.new(host, nil)
    http_client_class.new(host, port, use_ssl: use_ssl, verifier: verifier)
  else
    ssl = Puppet::SSL::SSLProvider.new
    verifier = Puppet::SSL::Verifier.new(host, ssl.create_insecure_context)
    http_client_class.new(host, port, use_ssl: use_ssl, verifier: verifier)
  end
end