Skip to Content Skip to Search

LDAP URI SCHEMA (described in RFC2255).

Methods
A
B
D
E
F
H
N
S

Constants

COMPONENT = [ :scheme, :host, :port, :dn, :attributes, :scope, :filter, :extensions, ].freeze
 

An Array of the available components for URI::LDAP.
DEFAULT_PORT = 389
 

A Default port of 389 for URI::LDAP.
SCOPE = [ SCOPE_ONE = 'one', SCOPE_SUB = 'sub', SCOPE_BASE = 'base', ].freeze
 

Scopes available for the starting point.

  • SCOPE_BASE - the Base DN

  • SCOPE_ONE - one level under the Base DN, not including the base DN and not including any entries under this

  • SCOPE_SUB - subtrees, all entries at all levels

Class Public methods

build(args)

Description

Creates a new URI::LDAP object from components, with syntax checking.

The components accepted are host, port, dn, attributes, scope, filter, and extensions.

The components should be provided either as an Array, or as a Hash with keys formed by preceding the component names with a colon.

If an Array is used, the components must be passed in the order [host, port, dn, attributes, scope, filter, extensions].

Example:

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])

Source: show | on GitHub 

# File ruby/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

new(*arg)

Description

Creates a new URI::LDAP object from generic URI components as per RFC 2396. No LDAP-specific syntax checking is performed.

Arguments are scheme, userinfo, host, port, registry, path, opaque, query, and fragment, in that order.

Example:

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

See also URI::Generic.new.

Source: show | on GitHub 

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

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

  parse_dn
  parse_query
end

Instance Public methods

attributes()

Returns attributes.

Source: show | on GitHub 

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

attributes=(val)

Setter for attributes val.

Source: show | on GitHub 

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

dn()

Returns dn.

Source: show | on GitHub 

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

dn=(val)

Setter for dn val.

Source: show | on GitHub 

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

extensions()

Returns extensions.

Source: show | on GitHub 

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

extensions=(val)

Setter for extensions val.

Source: show | on GitHub 

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

filter()

Returns filter.

Source: show | on GitHub 

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

filter=(val)

Setter for filter val.

Source: show | on GitHub 

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

hierarchical?()

Checks if URI has a path. For URI::LDAP this will return false.

Source: show | on GitHub 

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

scope()

Returns scope.

Source: show | on GitHub 

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

scope=(val)

Setter for scope val.

Source: show | on GitHub 

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

Instance Protected methods

set_attributes(val)

Private setter for attributes val.

Source: show | on GitHub 

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

set_dn(val)

Private setter for dn val.

Source: show | on GitHub 

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

set_extensions(val)

Private setter for extensions val.

Source: show | on GitHub 

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

set_filter(val)

Private setter for filter val.

Source: show | on GitHub 

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

set_scope(val)

Private setter for scope val.

Source: show | on GitHub 

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