Class: URI::LDAP

Inherits:
Generic show all
Defined in:
lib/uri/ldap.rb

Overview

LDAP URI SCHEMA (described in RFC2255)

Constant Summary collapse

DEFAULT_PORT =

A Default port of 389 for URI::LDAP

389
COMPONENT =

An Array of the available components for URI::LDAP

[
  :scheme,
  :host, :port,
  :dn,
  :attributes,
  :scope,
  :filter,
  :extensions,
].freeze
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 - subtress, all entries at all levels

[
  SCOPE_ONE = 'one',
  SCOPE_SUB = 'sub',
  SCOPE_BASE = 'base',
].freeze

Constants inherited from Generic

Generic::USE_REGISTRY

Constants included from URI

DEFAULT_PARSER, HTML5ASCIIINCOMPAT, Parser, REGEXP, RFC3986_PARSER, TBLDECWWWCOMP_, TBLENCWWWCOMP_, VERSION, VERSION_CODE

Instance Attribute Summary

Attributes inherited from Generic

#fragment, #host, #opaque, #path, #port, #query, #scheme

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Generic

#==, #absolute?, build2, #coerce, component, #component, default_port, #default_port, #eql?, #find_proxy, #hash, #hostname, #hostname=, #inspect, #merge, #merge!, #normalize, #normalize!, #parser, #password, #password=, #registry, #registry=, #relative?, #route_from, #route_to, #select, #to_s, use_registry, #user, #user=, #userinfo, #userinfo=

Methods included from URI

decode_www_form, decode_www_form_component, encode_www_form, encode_www_form_component, extract, join, parse, regexp, scheme_list, split

Methods included from Escape

#escape, #unescape

Constructor Details

#initialize(*arg) ⇒ LDAP

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



109
110
111
112
113
114
115
116
117
118
# File 'lib/uri/ldap.rb', line 109

def initialize(*arg)
  super(*arg)

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

  parse_dn
  parse_query
end

Class Method Details

.build(args) ⇒ Object

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


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# 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

Instance Method Details

#attributesObject

returns attributes.



178
179
180
# File 'lib/uri/ldap.rb', line 178

def attributes
  @attributes
end

#attributes=(val) ⇒ Object

setter for attributes val



191
192
193
194
# File 'lib/uri/ldap.rb', line 191

def attributes=(val)
  set_attributes(val)
  val
end

#dnObject

returns dn.



159
160
161
# File 'lib/uri/ldap.rb', line 159

def dn
  @dn
end

#dn=(val) ⇒ Object

setter for dn val



172
173
174
175
# File 'lib/uri/ldap.rb', line 172

def dn=(val)
  set_dn(val)
  val
end

#extensionsObject

returns extensions.



235
236
237
# File 'lib/uri/ldap.rb', line 235

def extensions
  @extensions
end

#extensions=(val) ⇒ Object

setter for extensions val



248
249
250
251
# File 'lib/uri/ldap.rb', line 248

def extensions=(val)
  set_extensions(val)
  val
end

#filterObject

returns filter.



216
217
218
# File 'lib/uri/ldap.rb', line 216

def filter
  @filter
end

#filter=(val) ⇒ Object

setter for filter val



229
230
231
232
# File 'lib/uri/ldap.rb', line 229

def filter=(val)
  set_filter(val)
  val
end

#hierarchical?Boolean

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

Returns:

  • (Boolean)


255
256
257
# File 'lib/uri/ldap.rb', line 255

def hierarchical?
  false
end

#scopeObject

returns scope.



197
198
199
# File 'lib/uri/ldap.rb', line 197

def scope
  @scope
end

#scope=(val) ⇒ Object

setter for scope val



210
211
212
213
# File 'lib/uri/ldap.rb', line 210

def scope=(val)
  set_scope(val)
  val
end