class URI::LDAP

LDAP URI 模式（在 RFC2255 中描述）。

Constants

COMPONENT

可用组件的 Array，用于 URI::LDAP。

DEFAULT_PORT

URI::LDAP 的默认端口为 389。

SCOPE

起始点可用的范围。

SCOPE_BASE - 基本 DN
SCOPE_ONE - 基本 DN 的下一级，不包括基本 DN，也不包括此下的任何条目
SCOPE_SUB - 子树，所有级别的所有条目

Public Class Methods

build (args)

Source

# 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 对象，并进行语法检查。

可接受的组件是 host、port、dn、attributes、scope、filter 和 extensions。

组件应以 Array 的形式提供，或者以 Hash 的形式提供，其中键通过在组件名称前加上冒号形成。

如果使用 Array，则必须按 [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)

Source

# 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

描述

根据 RFC 2396 中的通用 URI 组件创建一个新的 URI::LDAP 对象。不执行特定于 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

Public Instance Methods

attributes ()

Source

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

返回 attributes。

attributes= (val)

Source

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

attributes val 的设置器。

dn ()

Source

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

返回 dn。

dn= (val)

Source

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

dn val 的设置器。

extensions ()

Source

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

返回 extensions。

extensions= (val)

Source

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

extensions val 的设置器。

filter ()

Source

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

返回 filter。

filter= (val)

Source

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

filter val 的设置器。

hierarchical? ()

Source

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

检查 URI 是否有 path。对于 URI::LDAP，这将返回 false。

scope ()

Source

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

返回 scope。

scope= (val)

Source

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

scope val 的设置器。

Protected Instance Methods

set_attributes (val)

Source

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

attributes val 的私有设置器。

set_dn (val)

Source

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

dn val 的私有设置器。

set_extensions (val)

Source

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

extensions val 的私有设置器。

set_filter (val)

Source

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

filter val 的私有设置器。

set_scope (val)

Source

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

scope val 的私有设置器。

私有实例方法

build_path_query ()

Source

# 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

私有方法，用于从 attributes、scope、filter 和 extensions 组装 query。

parse_dn ()

Source

# 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 ()

Source

# 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 组件属性。