org.springframework.ldap.repository

Annotation Type Query

@Target(value=METHOD)
@Retention(value=RUNTIME)
@Documented
public @interface Query

Annotation for use in LdapRepository declarations to create automatic query methods based on statically defined queries.

Since:

2.0

Author:

Mattias Hellborg Arthursson

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and 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).
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 Detail

base

public abstract String base

Search base, to be used as input to LdapQueryBuilder.base(javax.naming.Name).

Returns:

the search base, default is LdapUtils.emptyLdapName()

Default:

""

value

public abstract String value

The filter format string, to be used as input to LdapQueryBuilder.filter(String, Object...).

Returns:

search filter, must be specified.

Default:

""

searchScope

public abstract SearchScope searchScope

Search scope, to be used as input to LdapQueryBuilder.searchScope(org.springframework.ldap.query.SearchScope).

Returns:

the search scope.

Default:

org.springframework.ldap.query.SearchScope.SUBTREE

timeLimit

public abstract int timeLimit

Time limit, to be used as input to LdapQueryBuilder.timeLimit(int).

Returns:

the time limit.

Default:

0

countLimit

public abstract int countLimit

Count limit, to be used as input to LdapQueryBuilder.countLimit(int).

Returns:

the count limit.

Default:

0