Module io.inverno.mod.ldap
Package io.inverno.mod.ldap

Interface LDAPOperations.SearchBuilder

Enclosing interface:
LDAPOperations
public static interface LDAPOperations.SearchBuilder

A search builder is used to build complex search operations.

Since:
1.5
Author:
Jeremy Kuhn

  • Method Details

    • scope

      LDAPOperations.SearchBuilder scope(LDAPOperations.SearchScope scope)

      Specifies the search scope.

      Parameters:
      scope - a scope
      Returns:
      this builder

    • derefAliases

      LDAPOperations.SearchBuilder derefAliases()

      Specifies whether aliases should be dereferenced.

      Returns:
      this builder

    • sizeLimit

      LDAPOperations.SearchBuilder sizeLimit(int sizeLimit)

      Specified the size limit.

      Parameters:
      sizeLimit - the size limit
      Returns:
      this builder

    • timeLimit

      LDAPOperations.SearchBuilder timeLimit(int timeLimit)

      specifies the time limit.

      Parameters:
      timeLimit - the time limit
      Returns:
      this builder

    • typesOnly

      LDAPOperations.SearchBuilder typesOnly()

      Specifies whether only types should be returned.

      Returns:
      this builder

    • build

      Flux<LDAPEntry> build(String base, String filter) throws LDAPException

      Executes a search operation in the specified base context using the specified filter.

      Parameters:
      base - the base context
      filter - a filter
      Returns:
      a publisher of entries
      Throws:
      LDAPException - if there was an error during the search operation

    • build

      Flux<LDAPEntry> build(String base, String filter, Object... filterArgs) throws LDAPException

      Executes a search operation in the specified base context using the specified filter and arguments.

      Parameters:
      base - the base context
      filter - a filter
      filterArgs - the arguments to use to format the filter
      Returns:
      a publisher of entries
      Throws:
      LDAPException - if there was an error during the search operation

    • build

      Flux<LDAPEntry> build(String base, String[] attributes, String filter) throws LDAPException

      Executes a search operation in the specified base context using the specified filter returning the specified list of attributes.

      Parameters:
      base - the base context
      attributes - the list of attributes to query
      filter - a filter
      Returns:
      a publisher of entries
      Throws:
      LDAPException - if there was an error during the search operation

    • build

      Flux<LDAPEntry> build(String base, String[] attributes, String filter, Object... filterArgs) throws LDAPException

      Executes a search operation in the specified base context using the specified filter and arguments returning the specified list of attributes.

      Parameters:
      base - the base context
      attributes - the list of attributes to query
      filter - a filter
      filterArgs - the arguments to use to format the filter
      Returns:
      a publisher of entries
      Throws:
      LDAPException - if there was an error during the search operation