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.
_dump(depth)
click to toggle source
80: def _dump depth
81: to_ldif
82: end
attribute_names()
click to toggle source
Returns an array of the attribute names present in the Entry.
114: def attribute_names
115: @myhash.keys
116: end
dn()
click to toggle source
Returns the dn of the Entry as a String.
109: def dn
110: self[:dn][0].to_s
111: end
each()
click to toggle source
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.
124: def each
125: if block_given?
126: attribute_names.each {|a|
127: attr_name,values = a,self[a]
128: yield attr_name, values
129: }
130: end
131: end
each_attribute()
click to toggle source
respond_to?(sym)
click to toggle source
191: def respond_to?(sym)
192: name = attribute_name(sym)
193: return true if valid_attribute?(name)
194: return super
195: end
to_ldif()
click to toggle source
Converts the Entry to a String, representing the Entry’s
attributes in LDIF format.
138: def to_ldif
139: ary = []
140: ary << "dn: #{dn}\n"
141: v2 = ""
142: each_attribute do |k,v|
143: unless k == :dn
144: v.each {|v1|
145: v2 = if (k == :userpassword) || is_attribute_value_binary?(v1)
146: ": #{Base64.encode64(v1).chomp.gsub(/\n/m,"\n ")}"
147: else
148: " #{v1}"
149: end
150: ary << "#{k}:#{v2}\n"
151: }
152: end
153: end
154: ary << "\n"
155: ary.join
156: end
write()
click to toggle source
![[+]](../../images/find.png "show/hide quicksearch")