Annotation Interface Query

@Target(METHOD) @Retention(RUNTIME) @Documented public @interface Query
Annotation for use in LdapRepository declarations to create automatic query methods based on statically defined queries.

LDAP queries support parameter bindings (by-index using ?0, by-name using :someParam), SpEL expressions, and Configuration Properties to create dynamic queries. All non-String arguments are converted to their toString representation to render the query.

Author:
Mattias Hellborg Arthursson

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    base
    Search base, to be used as input to LdapQueryBuilder.base(javax.naming.Name) .
    int
    countLimit
    Count limit, to be used as input to LdapQueryBuilder.countLimit(int).
    org.springframework.ldap.query.SearchScope
    searchScope
    Search scope, to be used as input to LdapQueryBuilder.searchScope(org.springframework.ldap.query.SearchScope).
    int
    timeLimit
    Time limit, to be used as input to LdapQueryBuilder.timeLimit(int).
    String
    value
    The filter format string, to be used as input to LdapQueryBuilder.filter(String, Object...).

  • Element Details

    • base

      String base
      Search base, to be used as input to LdapQueryBuilder.base(javax.naming.Name) . Supports parameter binding.
      Returns:
      the search base, default is LdapUtils.emptyLdapName()
      Default:
      ""

    • value

      String value
      The filter format string, to be used as input to LdapQueryBuilder.filter(String, Object...). Supports parameter binding.
      Returns:
      search filter, must be specified.
      Default:
      ""

    • searchScope

      org.springframework.ldap.query.SearchScope searchScope
      Search scope, to be used as input to LdapQueryBuilder.searchScope(org.springframework.ldap.query.SearchScope).
      Returns:
      the search scope.
      Default:
      SUBTREE

    • timeLimit

      int timeLimit
      Time limit, to be used as input to LdapQueryBuilder.timeLimit(int).
      Returns:
      the time limit.
      Default:
      0

    • countLimit

      int countLimit
      Count limit, to be used as input to LdapQueryBuilder.countLimit(int).
      Returns:
      the count limit.
      Default:
      0