класс URI::LDAP

Родитель:: URI::Generic

LDAP URI СХЕМА (описанная в RFC2255).

Константы

COMPONENT

Массив доступных компонентов для URI::LDAP.

DEFAULT_PORT

Порт по умолчанию 389 для URI::LDAP.

SCOPE

Доступные области для начальной точки.

SCOPE_BASE - базовая DN
SCOPE_ONE - один уровень ниже базовой DN, не включая саму базу DN и не включая записи под ней
SCOPE_SUB - поддеревья, все записи на всех уровнях

Методы публичного класса

build (args)

Исходный код

# File lib/uri/ldap.rb, line 74
def self.build(args)
  tmp = Util::make_components_hash(self, args)

  if tmp[:dn]
    tmp[:path] = tmp[:dn]
  end

  query = []
  [:extensions, :filter, :scope, :attributes].collect do |x|
    next if !tmp[x] && query.size == 0
    query.unshift(tmp[x])
  end

  tmp[:query] = query.join('?')

  return super(tmp)
end

Описание

Создаёт новый объект URI::LDAP из компонентов с проверкой синтаксиса.

Принимаемые компоненты: хост, порт, dn, атрибуты, область, фильтр и расширения.

Компоненты должны быть предоставлены либо в виде массива, либо в виде хэша с ключами, образованными путём добавления префикса «:» к именам компонентов.

Если используется массив, компоненты должны быть переданы в порядке [host, port, dn, attributes, scope, filter, extensions].

Пример:

uri = URI::LDAP.build({:host => 'ldap.example.com',
  :dn => '/dc=example'})

uri = URI::LDAP.build(["ldap.example.com", nil,
  "/dc=example;dc=com", "query", nil, nil, nil])

Вызов метода родительского класса URI::Generic::build

new (*arg)

Исходный код

# File lib/uri/ldap.rb, line 108
def initialize(*arg)
  super(*arg)

  if @fragment
    raise InvalidURIError, 'bad LDAP URL'
  end

  parse_dn
  parse_query
end

Описание

Создаёт новый объект URI::LDAP из компонентов универсальной URI согласно RFC 2396. Проверка синтаксиса, специфичная для LDAP, не выполняется.

Аргументы передаются в следующем порядке: scheme, userinfo, host, port, registry, path, opaque, query, и fragment.

Пример:

uri = URI::LDAP.new("ldap", nil, "ldap.example.com", nil, nil,
  "/dc=example;dc=com", nil, "query", nil)

См. также URI::Generic.new.

Вызов метода родительского класса URI::Generic::new

Методы публичного экземпляра

attributes ()

Исходный код

# File lib/uri/ldap.rb, line 178
def attributes
  @attributes
end

Возвращает атрибуты.

attributes= (val)

Исходный код

# File lib/uri/ldap.rb, line 191
def attributes=(val)
  set_attributes(val)
  val
end

Установка атрибутов val.

dn ()

Исходный код

# File lib/uri/ldap.rb, line 159
def dn
  @dn
end

Возвращает dn.

dn= (val)

Исходный код

# File lib/uri/ldap.rb, line 172
def dn=(val)
  set_dn(val)
  val
end

Устанавливает dn val.

extensions ()

Исходный код

# File lib/uri/ldap.rb, line 235
def extensions
  @extensions
end

Возвращает расширения.

extensions= (val)

Исходный код

# File lib/uri/ldap.rb, line 248
def extensions=(val)
  set_extensions(val)
  val
end

Устанавливает расширения val.

filter ()

Исходный код

# File lib/uri/ldap.rb, line 216
def filter
  @filter
end

Возвращает фильтр.

filter= (val)

Исходный код

# File lib/uri/ldap.rb, line 229
def filter=(val)
  set_filter(val)
  val
end

Устанавливает фильтр val.

hierarchical? ()

Исходный код

# File lib/uri/ldap.rb, line 255
def hierarchical?
  false
end

Проверяет, содержит ли URI путь. Для URI::LDAP это вернёт false.

scope ()

Исходный код

# File lib/uri/ldap.rb, line 197
def scope
  @scope
end

Возвращает область.

scope= (val)

Исходный код

# File lib/uri/ldap.rb, line 210
def scope=(val)
  set_scope(val)
  val
end

Устанавливает область val.

Защищенные методы экземпляра

set_attributes (val)

Исходный код

# File lib/uri/ldap.rb, line 183
def set_attributes(val)
  @attributes = val
  build_path_query
  @attributes
end

Приватный метод-сеттер для атрибутов val.

set_dn (val)

Исходный код

# File lib/uri/ldap.rb, line 164
def set_dn(val)
  @dn = val
  build_path_query
  @dn
end

Приватный метод-сеттер для dn val.

set_extensions (val)

Исходный код

# File lib/uri/ldap.rb, line 240
def set_extensions(val)
  @extensions = val
  build_path_query
  @extensions
end

Приватный метод-сеттер для расширений val.

set_filter (val)

Исходный код

# File lib/uri/ldap.rb, line 221
def set_filter(val)
  @filter = val
  build_path_query
  @filter
end

Приватный метод-сеттер для фильтра val.

set_scope (val)

Исходный код

# File lib/uri/ldap.rb, line 202
def set_scope(val)
  @scope = val
  build_path_query
  @scope
end

Приватный метод-сеттер для области val.

Приватные методы экземпляра

build_path_query ()

Исходный код

# File lib/uri/ldap.rb, line 146
def build_path_query
  @path = '/' + @dn

  query = []
  [@extensions, @filter, @scope, @attributes].each do |x|
    next if !x && query.size == 0
    query.unshift(x)
  end
  @query = query.join('?')
end

Приватный метод для сборки query из attributes, scope, filter, и extensions.

parse_dn ()

Исходный код

# File lib/uri/ldap.rb, line 120
def parse_dn
  raise InvalidURIError, 'bad LDAP URL' unless @path
  @dn = @path[1..-1]
end

Приватный метод для очистки dn от использования атрибута компонента path.

parse_query ()

Исходный код

# File lib/uri/ldap.rb, line 128
def parse_query
  @attributes = nil
  @scope      = nil
  @filter     = nil
  @extensions = nil

  if @query
    attrs, scope, filter, extensions = @query.split('?')

    @attributes = attrs if attrs && attrs.size > 0
    @scope      = scope if scope && scope.size > 0
    @filter     = filter if filter && filter.size > 0
    @extensions = extensions if extensions && extensions.size > 0
  end
end

Приватный метод для очистки attributes, scope, filter, и extensions от использования атрибута компонента query.

Ruby Core © 1993–2024 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.