Class: Net::LDAP::Entry

### Home Classes Methods

### In Files

- lib/net/ldap/entry.rb

### Parent

Object

### Methods

- ::attribute_name
- ::from_single_ldif_string
- #[]
- #[]=
- #attribute_names
- #dn
- #each
- #each_attribute
- #to_ldif

### Files

- History.rdoc
- Manifest.txt

### Class/Module Index

Quicksearch

- Net
- Net::BER
- Net::BER::BERParser
- Net::BER::BerError
- Net::BER::BerIdentifiedArray
- Net::BER::BerIdentifiedNull
- Net::BER::BerIdentifiedOid
- Net::BER::BerIdentifiedString
- Net::BER::Extensions
- Net::BER::Extensions::Array
- Net::BER::Extensions::Bignum
- Net::BER::Extensions::FalseClass
- Net::BER::Extensions::Fixnum
- Net::BER::Extensions::String
- Net::BER::Extensions::TrueClass
- Net::LDAP
- Net::LDAP::Connection
- Net::LDAP::Connection::GetbyteForSSLSocket
- Net::LDAP::DN
- Net::LDAP::Dataset
- Net::LDAP::Entry
- Net::LDAP::Filter
- Net::LDAP::LdapControls
- Net::LDAP::LdapError
- Net::LDAP::PDU
- Net::LDAP::PDU::Error
- Net::LDAP::Password
- OpenSSL
- OpenSSL::SSL
- OpenSSL::SSL::SSLSocket

No matching classes.

# Net::LDAP::Entry

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.

### Public Class Methods

attribute_name(name) click to toggle source

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

    # File lib/net/ldap/entry.rb, line 84
    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) click to toggle source

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.

    # File lib/net/ldap/entry.rb, line 68
    def from_single_ldif_string(ldif)
      ds = Net::LDAP::Dataset.read_ldif(::StringIO.new(ldif))

      return nil if ds.empty?

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

      entry = ds.to_entries.first

      return nil if entry.dn.nil?
      entry
    end

### Public Instance Methods

[](name) click to toggle source

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.

    # File lib/net/ldap/entry.rb, line 110
    def [](name)
      name = self.class.attribute_name(name)
      @myhash[name] || []
    end

[]=(name, value) click to toggle source

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]

    # File lib/net/ldap/entry.rb, line 102
    def []=(name, value)
      @myhash[self.class.attribute_name(name)] = Kernel::Array(value)
    end

attribute_names() click to toggle source

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

    # File lib/net/ldap/entry.rb, line 123
    def attribute_names
      @myhash.keys
    end

dn() click to toggle source

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

    # File lib/net/ldap/entry.rb, line 117
    def dn
      self[:dn].first.to_s
    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.

    # File lib/net/ldap/entry.rb, line 133
    def each # :yields: attribute-name, data-values-array
      if block_given?
        attribute_names.each {|a|
          attr_name,values = a,self[a]
          yield attr_name, values
        }
      end
    end

Also aliased as: each_attribute
each_attribute() click to toggle source
Alias for: each
to_ldif() click to toggle source

Converts the Entry to an LDIF-formatted String

    # File lib/net/ldap/entry.rb, line 145
    def to_ldif
      Net::LDAP::Dataset.from_entry(self).to_ldif_string
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.