class URI::LDAP

LDAP URI SCHEMA (described in RFC2255).

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

build

(Array[nil | String | Integer] args) → URI::LDAP
({ host: String?, port: Integer?, dn: String?, attributes: String?, scope: String?, filter: String?, extensions: String? }) → URI::LDAP

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 52
def self.build: (Array[nil | String | Integer] args) -> URI::LDAP
                  | ({ host: String?, port: Integer?, dn: String?, attributes: String?, scope: String?, filter: String?, extensions: String? }) -> URI::LDAP

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

new

(String schema, String? userinfo, String host, Integer? port, String? registry, String? path, String? opaque, String query, String? fragment) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 74
def initialize: (String schema, String? userinfo, String host, Integer? port, String? registry, String? path, String? opaque, String query, String? fragment) -> void

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)

Public Instance Methods

attributes

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 132
def attributes: () -> String

Returns attributes.

attributes=

(String val) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 148
def attributes=: (String val) -> String

Setter for attributes val.

build_path_query

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 100
def build_path_query: () -> String

Private method to assemble query from attributes, scope, filter, and extensions.

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 108
def dn: () -> String

Returns dn.

dn=

(String val) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 124
def dn=: (String val) -> String

Setter for dn val.

extensions

() → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 204
def extensions: () -> untyped

Returns extensions.

extensions=

(String val) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 220
def extensions=: (String val) -> String

Setter for extensions val.

filter

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 180
def filter: () -> String

Returns filter.

filter=

(String val) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 196
def filter=: (String val) -> String

Setter for filter val.

hierarchical?

() → ::FalseClass

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 228
def hierarchical?: () -> ::FalseClass

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

parse_dn

() → nil

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 82
def parse_dn: () -> nil

Private method to cleanup dn from using the path component attribute.

parse_query

() → nil

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 91
def parse_query: () -> nil

Private method to cleanup attributes, scope, filter, and extensions from using the query component attribute.

scope

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 156
def scope: () -> String

Returns scope.

scope=

(String val) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 172
def scope=: (String val) -> String

Setter for scope val.

set_attributes

(String val) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 140
def set_attributes: (String val) -> String

Private setter for attributes val.

set_dn

(String val) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 116
def set_dn: (String val) -> String

Private setter for dn val.

set_extensions

(String val) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 212
def set_extensions: (String val) -> String

Private setter for extensions val.

set_filter

(String val) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 188
def set_filter: (String val) -> String

Private setter for filter val.

set_scope

(String val) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/ldap.rbs, line 164
def set_scope: (String val) -> String

Private setter for scope val.