Class: Net::LDAP::Entry

Inherits:
Object
  • Object
show all
Defined in:
lib/net/ldap/entry.rb

Overview

-*- ruby encoding: utf-8 -*-

Objects of this class represent individual entries in an LDAP directory. User code generally does not instantiate this class. Net::LDAP#search provides objects of this class to user code, either as block parameters or as return values.

In LDAP-land, an “entry” is a collection of attributes that are uniquely and globally identified by a DN (“Distinguished Name”). Attributes are identified by short, descriptive words or phrases. Although a directory is free to implement any attribute name, most of them follow rigorous standards so that the range of commonly-encountered attribute names is not large.

An attribute name is case-insensitive. Most directories also restrict the range of characters allowed in attribute names. To simplify handling attribute names, Net::LDAP::Entry internally converts them to a standard format. Therefore, the methods which take attribute names can take Strings or Symbols, and work correctly regardless of case or capitalization.

An attribute consists of zero or more data items called values. An entry is the combination of a unique DN, a set of attribute names, and a (possibly-empty) array of values for each attribute.

Class Net::LDAP::Entry provides convenience methods for dealing with LDAP entries. In addition to the methods documented below, you may access individual attributes of an entry simply by giving the attribute name as the name of a method call. For example:

ldap.search( ... ) do |entry|
  puts "Common name: #{entry.cn}"
  puts "Email addresses:"
  entry.mail.each {|ma| puts ma}
end

If you use this technique to access an attribute that is not present in a particular Entry object, a NoMethodError exception will be raised.

– Ugly problem to fix someday: We key off the internal hash with a canonical form of the attribute name: convert to a string, downcase, then take the symbol. Unfortunately we do this in at least three places. Should do it in ONE place.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dn = nil) ⇒ Entry

This constructor is not generally called by user code.


49
50
51
52
# File 'lib/net/ldap/entry.rb', line 49

def initialize(dn = nil) #:nodoc:
  @myhash = {}
  @myhash[:dn] = [dn]
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args, &block) ⇒ Object

:nodoc:


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/net/ldap/entry.rb', line 171

def method_missing(sym, *args, &block) #:nodoc:
  name = self.class.attribute_name(sym)

  if valid_attribute?(name )
    if setter?(sym) && args.size == 1
      value = args.first
      value = Array(value)
      self[name]= value
      return value
    elsif args.empty?
      return self[name]
    end
  end

  super
end

Class Method Details

._load(entry) ⇒ Object

Use the LDIF format for Marshal serialization.


62
63
64
# File 'lib/net/ldap/entry.rb', line 62

def self._load(entry) #:nodoc:
  from_single_ldif_string(entry)
end

.attribute_name(name) ⇒ Object

Canonicalizes an LDAP attribute name as a Symbol. The name is lowercased and, if present, a trailing equals sign is removed.


87
88
89
90
91
# File 'lib/net/ldap/entry.rb', line 87

def attribute_name(name)
  name = name.to_s.downcase
  name = name[0..-2] if name[-1] == ?=
  name.to_sym
end

.from_single_ldif_string(ldif) ⇒ Object

Converts a single LDIF entry string into an Entry object. Useful for Marshal serialization. If a string with multiple LDIF entries is provided, an exception will be raised.


71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/net/ldap/entry.rb', line 71

def from_single_ldif_string(ldif)
  ds = Net::LDAP::Dataset.read_ldif(::StringIO.new(ldif))

  return nil if ds.empty?

  raise Net::LDAP::EntryOverflowError, "Too many LDIF entries" unless ds.size == 1

  entry = ds.to_entries.first

  return nil if entry.dn.nil?
  entry
end

Instance Method Details

#==(other) ⇒ Object


200
201
202
# File 'lib/net/ldap/entry.rb', line 200

def ==(other)
  other.instance_of?(self.class) && @myhash == other.to_h
end

#[](name) ⇒ Object

Reads the array of values for the provided attribute. The attribute name is canonicalized prior to reading. Returns an empty array if the attribute does not exist.


113
114
115
116
# File 'lib/net/ldap/entry.rb', line 113

def [](name)
  name = self.class.attribute_name(name)
  @myhash[name] || []
end

#[]=(name, value) ⇒ Object

Sets or replaces the array of values for the provided attribute. The attribute name is canonicalized prior to assignment.

When an attribute is set using this, that attribute is now made accessible through methods as well.

entry = Net::LDAP::Entry.new("dc=com")
entry.foo             # => NoMethodError
entry["foo"] = 12345  # => [12345]
entry.foo             # => [12345]

105
106
107
# File 'lib/net/ldap/entry.rb', line 105

def []=(name, value)
  @myhash[self.class.attribute_name(name)] = Kernel::Array(value)
end

#_dump(depth) ⇒ Object

Use the LDIF format for Marshal serialization.


56
57
58
# File 'lib/net/ldap/entry.rb', line 56

def _dump(depth) #:nodoc:
  to_ldif
end

#attribute_namesObject

Returns an array of the attribute names present in the Entry.


134
135
136
# File 'lib/net/ldap/entry.rb', line 134

def attribute_names
  @myhash.keys
end

#dnObject

Returns the first distinguished name (dn) of the Entry as a String.


128
129
130
# File 'lib/net/ldap/entry.rb', line 128

def dn
  self[:dn].first.to_s
end

#eachObject Also known as: each_attribute

Accesses each of the attributes present in the Entry.

Calls a user-supplied block with each attribute in turn, passing two arguments to the block: a Symbol giving the name of the attribute, and a (possibly empty) Array of data values.


151
152
153
154
155
156
157
# File 'lib/net/ldap/entry.rb', line 151

def each # :yields: attribute-name, data-values-array
  return unless block_given?
  attribute_names.each do|a|
    attr_name, values = a, self[a]
    yield attr_name, values
  end
end

#first(name) ⇒ Object

Read the first value for the provided attribute. The attribute name is canonicalized prior to reading. Returns nil if the attribute does not exist.


122
123
124
# File 'lib/net/ldap/entry.rb', line 122

def first(name)
  self[name].first
end

#respond_to?(sym, include_all = false) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)

166
167
168
169
# File 'lib/net/ldap/entry.rb', line 166

def respond_to?(sym, include_all = false) #:nodoc:
  return true if valid_attribute?(self.class.attribute_name(sym))
  return super
end

#to_hObject

Creates a duplicate of the internal Hash containing the attributes of the entry.


141
142
143
# File 'lib/net/ldap/entry.rb', line 141

def to_h
  @myhash.dup
end

#to_ldifObject

Converts the Entry to an LDIF-formatted String


162
163
164
# File 'lib/net/ldap/entry.rb', line 162

def to_ldif
  Net::LDAP::Dataset.from_entry(self).to_ldif_string
end