Class: Puppet::Provider::Ldap

Inherits:
Puppet::Provider show all
Defined in:
lib/puppet/provider/ldap.rb

Overview

The base class for LDAP providers.

API:

  • public

Constant Summary

Constants inherited from Puppet::Provider

Confine

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Constants included from Util::Docs

Util::Docs::HEADER_LEVELS

Class Attribute Summary collapse

Attributes inherited from Puppet::Provider

#model, #resource

Attributes included from Util::Docs

#doc, #nodoc

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Puppet::Provider

#<=>, #clear, #command, command, commands, declared_feature?, default?, default_match, defaultfor, execfail, #execfail, execpipe, #execpipe, execute, #execute, fact_match, feature_match, #get, has_command, initvars, make_command_methods, mk_resource_methods, #name, optional_commands, post_resource_eval, #set, specificity, supports_parameter?, #to_s

Methods included from Util::Logging

#clear_deprecation_warnings, #deprecation_warning, #format_exception, #get_deprecation_offender, #log_and_raise, #log_deprecations_to_file, #log_exception, #puppet_deprecation_warning, #send_log

Methods included from Util

absolute_path?, activerecord_version, benchmark, binread, chuser, classproxy, deterministic_rand, execfail, execpipe, execute, exit_on_fail, logmethods, memory, path_to_uri, pretty_backtrace, proxy, replace_file, safe_posix_fork, symbolizehash, thinmark, uri_to_path, which, withenv, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from Util::SymbolicFileMode

#normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Methods included from Util::Docs

#desc, #dochook, #doctable, #markdown_definitionlist, #markdown_header, #nodoc?, #pad, scrub

Methods included from Util::Warnings

clear_warnings, debug_once, notice_once, warnonce

Methods included from Confiner

#confine, #confine_collection, #suitable?

Methods included from Util::Errors

#adderrorcontext, #devfail, #error_context, #exceptwrap, #fail

Constructor Details

#initialize(*args) ⇒ Ldap

Returns a new instance of Ldap.

Raises:

API:

  • public



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/puppet/provider/ldap.rb', line 76

def initialize(*args)
  raise(Puppet::DevError, "No LDAP Configuration defined for #{self.class}") unless self.class.manager
  raise(Puppet::DevError, "Invalid LDAP Configuration defined for #{self.class}") unless self.class.manager.valid?
  super

  @property_hash = @property_hash.inject({}) do |result, ary|
    param, values = ary

    # Skip any attributes we don't manage.
    next result unless self.class.resource_type.valid_parameter?(param)

    paramclass = self.class.resource_type.attrclass(param)

    unless values.is_a?(Array)
      result[param] = values
      next result
    end

    # Only use the first value if the attribute class doesn't manage
    # arrays of values.
    if paramclass.superclass == Puppet::Parameter or paramclass.array_matching == :first
      result[param] = values[0]
    else
      result[param] = values
    end
    result
  end

  # Make a duplicate, so that we have a copy for comparison
  # at the end.
  @ldap_properties = @property_hash.dup
end

Class Attribute Details

.manager ⇒ Object (readonly)

API:

  • public



8
9
10
 
# File 'lib/puppet/provider/ldap.rb', line 8

def manager
  @manager
end

Class Method Details

.instances ⇒ Object

Look up all instances at our location. Yay.

API:

  • public



12
13
14
15
16
 
# File 'lib/puppet/provider/ldap.rb', line 12

def self.instances
  return [] unless list = manager.search

  list.collect { |entry| new(entry) }
end

.manages(*args) ⇒ Object

Specify the ldap manager for this provider, which is used to figure out how we actually interact with ldap.

API:

  • public



20
21
22
23
24
25
26
27
 
# File 'lib/puppet/provider/ldap.rb', line 20

def self.manages(*args)
  @manager = Puppet::Util::Ldap::Manager.new
  @manager.manages(*args)

  # Set up our getter/setter methods.
  mk_resource_methods
  @manager
end

.prefetch(resources) ⇒ Object

Query all of our resources from ldap.

API:

  • public



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/puppet/provider/ldap.rb', line 30

def self.prefetch(resources)
  resources.each do |name, resource|
    if result = manager.find(name)
      result[:ensure] = :present
      resource.provider = new(result)
    else
      resource.provider = new(:ensure => :absent)
    end
  end
end

Instance Method Details

#create ⇒ Object

API:

  • public



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/puppet/provider/ldap.rb', line 45

def create
  @property_hash[:ensure] = :present
  self.class.resource_type.validproperties.each do |property|
    if val = resource.should(property)
      if property.to_s == 'gid'
        self.gid = val
      else
        @property_hash[property] = val
      end
    end
  end
end

#delete ⇒ Object

API:

  • public



58
59
60
 
# File 'lib/puppet/provider/ldap.rb', line 58

def delete
  @property_hash[:ensure] = :absent
end

#exists? ⇒ Boolean

Returns:

API:

  • public



62
63
64
 
# File 'lib/puppet/provider/ldap.rb', line 62

def exists?
  @property_hash[:ensure] != :absent
end

#flush ⇒ Object

Apply our changes to ldap, yo.

API:

  • public



67
68
69
70
71
72
73
74
 
# File 'lib/puppet/provider/ldap.rb', line 67

def flush
  # Just call the manager's update() method.
  @property_hash.delete(:groups)
  @ldap_properties.delete(:groups)
  manager.update(name, ldap_properties, properties)
  @property_hash.clear
  @ldap_properties.clear
end

#ldap_properties ⇒ Object

Return the current state of ldap.

API:

  • public



110
111
112
 
# File 'lib/puppet/provider/ldap.rb', line 110

def ldap_properties
  @ldap_properties.dup
end

#manager ⇒ Object

API:

  • public



41
42
43
 
# File 'lib/puppet/provider/ldap.rb', line 41

def manager
  self.class.manager
end

#properties ⇒ Object

Return (and look up if necessary) the desired state.

API:

  • public



115
116
117
118
119
120
121
 
# File 'lib/puppet/provider/ldap.rb', line 115

def properties
  if @property_hash.empty?
    @property_hash = query || {:ensure => :absent}
    @property_hash[:ensure] = :absent if @property_hash.empty?
  end
  @property_hash.dup
end

#query ⇒ Object

Collect the current attributes from ldap. Returns the results, but also stores the attributes locally, so we have something to compare against when we update. LAK:NOTE This is normally not used, because we rely on prefetching.

API:

  • public



127
128
129
130
131
132
133
134
135
136
 
# File 'lib/puppet/provider/ldap.rb', line 127

def query
  # Use the module function.
  unless attributes = manager.find(name)
    @ldap_properties = {}
    return nil
  end

  @ldap_properties = attributes
  @ldap_properties.dup
end