elixir_ldap v0.3.0 ElixirLdap.Search

Documentation for ElixirLdap.Search

Link to this section Summary

Functions

search filter equality match

search filter greater number

search filter less number

search filter attribute

search base dn entry. Filter will search for equal

search single level entry. Filter approximation match filter

Search base dn all entry. Search by base dn set in config file

Search base dn all entry. Use the base DN of the argument

search base dn all entry. DN is argument base search and deref aliase is argument

search single level entry. Filter will search for equal

search single level entry. Filter approximation match filter

Search single level all entry. Use the base DN of config file

Search single level all entry. Use the base DN of argument

Search single level all entry. Use the base DN of argument. deref aliases is argument

search sub tree entry. Filter will search for equal

search sub tree entry. Filter will search less number. Use the base DN of the argument

and search filter

not search filter

or search filter

Link to this section Functions

Link to this function approx_match(type, value)
Link to this function boolean_match()
Link to this function case_exact_match()
Link to this function case_exact_ordering_match()
Link to this function case_exact_substrings_match()
Link to this function case_ignore_match()
Link to this function case_ignore_substrings_match()
Link to this function distinguished_name_match()
Link to this function equality_match(field, name)

search filter equality match

Exsample

ElixirLdap.Serach.equality_match("cn", "User01")
Link to this function extensible_match(match_value, type, matching_rule, dn_attributes \\ false)
Link to this function greater_or_equal(type, value)

search filter greater number

Exsample

ElixirLdap.Serach.greater_or_equal("age", "22")
Link to this function integer_match()
Link to this function integer_ordering_match()
Link to this function less_or_equal(type, value)

search filter less number

Exsample

ElixirLdap.Serach.less_or_equal("age", "22")
Link to this function numeric_string_match()
Link to this function numeric_string_ordering_match()
Link to this function numeric_string_substrings_match()
Link to this function object_identifer_match()
Link to this function octet_string_match()

search filter attribute

Exsample

ElixirLdap.Serach.present("telephoneNumber")
Link to this function search(handle, options)
Link to this function search(handle, base, scope, filter, deref, types_only \\ false, timeout \\ 0)

this function actually search

Link to this function search_base(handle, options)

search base dn entry. Filter will search for equal.

Exsample

ElixirLdap.Search.search_base(handle, [filter: :equal, field: 'ou', name: 'Server'])
ElixirLdap.Search.search_base(handle, [filter: :present, type: 'ou'])
ElixirLdap.Search.search_base(handle, [filter: :greater, type: 'age', value: "22")
ElixirLdap.Search.search_base(handle, [filter: :less, type: 'age', value: "22")
Link to this function search_base(handle, base, options)
Link to this function search_base(handle, base, list, def)

search single level entry. Filter approximation match filter.

Example

ElixirLdap.Search.search_base(handle, 'ou=People,dc=corporation,dc=home,dc=local', [filter: :approx, type: 'age', value: "22"], :deref_always)

the argument def are:

* never_deref_aliases    - Do not refer to alias entries
* deref_in_searching     - If the base DN of the search is an alias entry, it refers to it, ignoring the alias entry under it
* deref_finding_baes_obj - If the base DN of the search is an alias entry no search is performed. If the base DN is not an alias entry, a search is performed, and furthermore, an alias entry under the base DN is referred to
* deref_always           - Always refer to alias entries
Link to this function search_base_all(handle)

Search base dn all entry. Search by base dn set in config file.

Example

ElixirLdap.Search.search_base_all(handle)
Link to this function search_base_all(handle, base)

Search base dn all entry. Use the base DN of the argument.

Example

ElixirLdap.Search.search_base_all(handle, 'ou=Server,dc=corporation,dc=home,dc=local')
Link to this function search_base_all(handle, base, def)

search base dn all entry. DN is argument base search and deref aliase is argument.

Example

ElixirLdap.Search.search_base_all(handle, "ou=Server,dc=corporation,dc=home,dc=local", :deref_always)

the argument def are:

* never_deref_aliases    - Do not refer to alias entries
* deref_in_searching     - If the base DN of the search is an alias entry, it refers to it, ignoring the alias entry under it
* deref_finding_baes_obj - If the base DN of the search is an alias entry no search is performed. If the base DN is not an alias entry, a search is performed, and furthermore, an alias entry under the base DN is referred to
* deref_always           - Always refer to alias entries
Link to this function search_single_level(handle, options)

search single level entry. Filter will search for equal.

Exsample

ElixirLdap.Search.search_single_level(handle, [filter: :equal, field: 'ou', name: 'Server'])
ElixirLdap.Search.search_single_level(handle, [filter: :present, type: 'ou'])
ElixirLdap.Search.search_single_level(handle, [filter: :greater, type: 'age', value: "22")
ElixirLdap.Search.search_single_level(handle, [filter: :less, type: 'age', value: "22")
ElixirLdap.Search.search_single_level(handle, [filter: :approx, type: 'age', value: "22"])
Link to this function search_single_level(handle, base, options)
Link to this function search_single_level(handle, base, list, def)

search single level entry. Filter approximation match filter.

Example

ElixirLdap.Search.search_single_level(handle, 'ou=People,dc=corporation,dc=home,dc=local', [filter: :approx, type: 'age', value: "22"], :deref_always)

the argument def are:

* never_deref_aliases    - Do not refer to alias entries
* deref_in_searching     - If the base DN of the search is an alias entry, it refers to it, ignoring the alias entry under it
* deref_finding_baes_obj - If the base DN of the search is an alias entry no search is performed. If the base DN is not an alias entry, a search is performed, and furthermore, an alias entry under the base DN is referred to
* deref_always           - Always refer to alias entries
Link to this function search_single_level_all(handle)

Search single level all entry. Use the base DN of config file.

Example

ElixirLdap.Search.search_single_level_all(handle)
Link to this function search_single_level_all(handle, base)

Search single level all entry. Use the base DN of argument.

Example

ElixirLdap.Search.search_single_level_all(handle, "ou=Server,dc=corporation,dc=home,dc=local")
Link to this function search_single_level_all(handle, base, def)

Search single level all entry. Use the base DN of argument. deref aliases is argument

Example

ElixirLdap.Search.search_single_level_all(handle, "ou=Server,dc=corporation,dc=home,dc=local", :deref_always)

the argument def are:

* never_deref_aliases    - Do not refer to alias entries
* deref_in_searching     - If the base DN of the search is an alias entry, it refers to it, ignoring the alias entry under it
* deref_finding_baes_obj - If the base DN of the search is an alias entry no search is performed. If the base DN is not an alias entry, a search is performed, and furthermore, an alias entry under the base DN is referred to
* deref_always           - Always refer to alias entries
Link to this function search_subtree(handle, options)

search sub tree entry. Filter will search for equal.

Exsample

ElixirLdap.Search.search_subtree(handle, [filter: :equal, field: 'ou', name: 'Server'])
ElixirLdap.Search.search_subtree(handle, [filter: :present, type: 'ou'])
ElixirLdap.Search.search_subtree(handle, [filter: :greater, type: 'age', value: "22"])
ElixirLdap.Search.search_subtree(handle, [filter: :less, type: 'age', value: "22"])
Link to this function search_subtree(handle, base, options)
Link to this function search_subtree(handle, base, list, def)

search sub tree entry. Filter will search less number. Use the base DN of the argument.

Exsample

ElixirLdap.Search.search_subtree(handle, 'ou=People,dc=corporation,dc=home,dc=local', [filter: :greater, type: 'age', value: "22"], :deref_always)

the argument def are:

* never_deref_aliases    - Do not refer to alias entries
* deref_in_searching     - If the base DN of the search is an alias entry, it refers to it, ignoring the alias entry under it
* deref_finding_baes_obj - If the base DN of the search is an alias entry no search is performed. If the base DN is not an alias entry, a search is performed, and furthermore, an alias entry under the base DN is referred to
* deref_always           - Always refer to alias entries
Link to this function search_subtree_all(handle)
Link to this function search_subtree_all(handle, base)
Link to this function search_subtree_all(handle, base, def)
Link to this function substrings(type, value)
Link to this function with_and(filters)

and search filter

Link to this function with_not(filters)

not search filter

Link to this function with_or(filters)

or search filter