Package org.springframework.ldap.query
Interface LdapQuery
-
- All Known Subinterfaces:
ContainerCriteria
- All Known Implementing Classes:
LdapQueryBuilder
public interface LdapQuery
Holds all information regarding a Ldap query to be performed. Contains information regarding search base, search scope, time and count limits, and search filter.- Since:
- 2.0
- See Also:
LdapQueryBuilder
,LdapOperations.search(LdapQuery, org.springframework.ldap.core.AttributesMapper)
,LdapOperations.search(LdapQuery, org.springframework.ldap.core.ContextMapper)
,LdapOperations.searchForObject(LdapQuery, org.springframework.ldap.core.ContextMapper)
,LdapOperations.searchForContext(LdapQuery)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String[]
attributes()
Get the attributes to return.javax.naming.Name
base()
Get the search base.java.lang.Integer
countLimit()
Get the count limit.Filter
filter()
Get the filter.SearchScope
searchScope()
Get the search scope.java.lang.Integer
timeLimit()
Get the time limit.
-
-
-
Method Detail
-
base
javax.naming.Name base()
Get the search base. Default isLdapUtils.emptyLdapName()
.- Returns:
- the search base.
-
searchScope
SearchScope searchScope()
Get the search scope. Default isnull
, indicating that the LdapTemplate default should be used.- Returns:
- the search scope.
-
timeLimit
java.lang.Integer timeLimit()
Get the time limit. Default isnull
, indicating that the LdapTemplate default should be used.- Returns:
- the time limit.
-
countLimit
java.lang.Integer countLimit()
Get the count limit. Default isnull
, indicating that the LdapTemplate default should be used.- Returns:
- the count limit.
-
attributes
java.lang.String[] attributes()
Get the attributes to return. Default isnull
, indicating that all attributes should be returned.- Returns:
- the attributes to return.
-
filter
Filter filter()
Get the filter.- Returns:
- the filter.
-
-