class URI::LDAP
Constants
- COMPONENT
An Array of the available components for
URI::LDAP
.- DEFAULT_PORT
A Default port of 389 for
URI::LDAP
.- SCOPE
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
-
Public Class Methods
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])
URI::Generic::build
# File 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¶ ↑
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
.
URI::Generic::new
# File uri/ldap.rb, line 108 def initialize(*arg) super(*arg) if @fragment raise InvalidURIError, 'bad LDAP URL' end parse_dn parse_query end
Public Instance Methods
Returns attributes.
# File uri/ldap.rb, line 178 def attributes @attributes end
Setter for attributes val
.
# File uri/ldap.rb, line 191 def attributes=(val) set_attributes(val) val end
Returns dn.
# File uri/ldap.rb, line 159 def dn @dn end
Setter for dn val
.
# File uri/ldap.rb, line 172 def dn=(val) set_dn(val) val end
Returns extensions.
# File uri/ldap.rb, line 235 def extensions @extensions end
Setter for extensions val
.
# File uri/ldap.rb, line 248 def extensions=(val) set_extensions(val) val end
Returns filter.
# File uri/ldap.rb, line 216 def filter @filter end
Setter for filter val
.
# File uri/ldap.rb, line 229 def filter=(val) set_filter(val) val end
Returns scope.
# File uri/ldap.rb, line 197 def scope @scope end
Setter for scope val
.
# File uri/ldap.rb, line 210 def scope=(val) set_scope(val) val end
Protected Instance Methods
Private setter for attributes val
.
# File uri/ldap.rb, line 183 def set_attributes(val) @attributes = val build_path_query @attributes end
Private setter for dn val
.
# File uri/ldap.rb, line 164 def set_dn(val) @dn = val build_path_query @dn end
Private setter for extensions val
.
# File uri/ldap.rb, line 240 def set_extensions(val) @extensions = val build_path_query @extensions end
Private setter for filter val
.
# File uri/ldap.rb, line 221 def set_filter(val) @filter = val build_path_query @filter end
Private setter for scope val
.
# File uri/ldap.rb, line 202 def set_scope(val) @scope = val build_path_query @scope end
Private Instance Methods
Private method to assemble query
from attributes
, scope
, filter
, and extensions
.
# File 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 cleanup dn
from using the path
component attribute.
# File uri/ldap.rb, line 120 def parse_dn raise InvalidURIError, 'bad LDAP URL' unless @path @dn = @path[1..-1] end
Private method to cleanup attributes
, scope
, filter
, and extensions
from using the query
component attribute.
# File 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