122 lines
3.6 KiB
Ruby
122 lines
3.6 KiB
Ruby
# $Id$
|
|
#
|
|
# LDAP Entry (search-result) support classes
|
|
#
|
|
#
|
|
#----------------------------------------------------------------------------
|
|
#
|
|
# Copyright (C) 2006 by Francis Cianfrocca. All Rights Reserved.
|
|
#
|
|
# Gmail: garbagecat10
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software
|
|
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
#
|
|
#---------------------------------------------------------------------------
|
|
#
|
|
|
|
|
|
|
|
|
|
module Net
|
|
class LDAP
|
|
|
|
|
|
# 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 Synmbols,
|
|
# and work correctly regardless of case or capitalization.
|
|
#
|
|
# An attribute consists of zero or more data items called
|
|
# <i>values.</i> 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.
|
|
#
|
|
class Entry
|
|
|
|
# This constructor is not generally called by user code.
|
|
def initialize dn = nil # :nodoc:
|
|
@myhash = Hash.new {|k,v| k[v] = [] }
|
|
@myhash[:dn] = [dn]
|
|
end
|
|
|
|
|
|
def []= name, value # :nodoc:
|
|
sym = name.to_s.downcase.intern
|
|
@myhash[sym] = value
|
|
end
|
|
|
|
|
|
#--
|
|
# We have to deal with this one as we do []=
|
|
# because this one and not the other one gets called
|
|
# in formulations like entry["CN"] << cn.
|
|
#
|
|
def [] name # :nodoc:
|
|
name = name.to_s.downcase.intern unless name.is_a?(Symbol)
|
|
@myhash[name]
|
|
end
|
|
|
|
# Returns the dn of the Entry as a String.
|
|
def dn
|
|
self[:dn][0]
|
|
end
|
|
|
|
# Returns an array of the attribute names present in the Entry.
|
|
def attribute_names
|
|
@myhash.keys
|
|
end
|
|
|
|
# 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.
|
|
#
|
|
def each
|
|
if block_given?
|
|
attribute_names.each {|a|
|
|
attr_name,values = a,self[a]
|
|
yield attr_name, values
|
|
}
|
|
end
|
|
end
|
|
|
|
alias_method :each_attribute, :each
|
|
|
|
end # class Entry
|
|
|
|
|
|
end # class LDAP
|
|
end # module Net
|
|
|
|
|