LDAP URI SCHEMA (described in RFC2255) ldap://<host>/<dn>[?<attrs>[?<scope>[?<filter>]]]
A Default port of 389 for URI::LDAP
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 - subtress, all entries at all levels
# File tmp/rubies/ruby-2.3.8/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
Description
Create 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:
newuri = URI::LDAP.build({:host => 'ldap.example.com',
:dn> => '/dc=example'})
newuri = URI::LDAP.build(["ldap.example.com", nil,
"/dc=example;dc=com", "query", nil, nil, nil])
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 109
def initialize(*arg)
super(*arg)
if @fragment
raise InvalidURIError, 'bad LDAP URL'
end
parse_dn
parse_query
end
Description
Create 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, "/dc=example;dc=com", "query", nil, nil, nil, nil)
See also URI::Generic.new
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 178
def attributes
@attributes
end
returns attributes.
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 191
def attributes=(val)
set_attributes(val)
val
end
setter for attributes val
# File tmp/rubies/ruby-2.3.8/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
private method to assemble query from attributes, scope, filter and extensions.
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 159
def dn
@dn
end
returns dn.
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 172
def dn=(val)
set_dn(val)
val
end
setter for dn val
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 235
def extensions
@extensions
end
returns extensions.
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 248
def extensions=(val)
set_extensions(val)
val
end
setter for extensions val
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 216
def filter
@filter
end
returns filter.
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 229
def filter=(val)
set_filter(val)
val
end
setter for filter val
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 255
def hierarchical?
false
end
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 121
def parse_dn
@dn = @path[1..-1]
end
private method to cleanup dn from using the path component attribute
# File tmp/rubies/ruby-2.3.8/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
private method to cleanup attributes, scope, filter and extensions, from using the query component attribute
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 197
def scope
@scope
end
returns scope.
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 210
def scope=(val)
set_scope(val)
val
end
setter for scope val
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 183
def set_attributes(val)
@attributes = val
build_path_query
@attributes
end
private setter for attributes val
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 164
def set_dn(val)
@dn = val
build_path_query
@dn
end
private setter for dn val
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 240
def set_extensions(val)
@extensions = val
build_path_query
@extensions
end
private setter for extensions val
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 221
def set_filter(val)
@filter = val
build_path_query
@filter
end
private setter for filter val
# File tmp/rubies/ruby-2.3.8/lib/uri/ldap.rb, line 202
def set_scope(val)
@scope = val
build_path_query
@scope
end
private setter for scope val