Package org.springframework.data.ldap.repository

Annotation Interface LdapEncode

@Target({PARAMETER,ANNOTATION_TYPE}) @Retention(RUNTIME) @Documented public @interface LdapEncode
Annotation which indicates that a method parameter should be encoded using a specific LdapEncoder for a repository query method invocation.

If no LdapEncoder is configured, bound method parameters are encoded using LdapEncoder.filterEncode(String). The default encoder considers chars such as * (asterisk) to be encoded which might interfere with the intent of running a Like query. Since Spring Data LDAP doesn't parse queries it is up to you to decide which encoder to use.

LdapEncoder implementations must declare a no-args constructor so they can be instantiated during repository initialization.

Note that parameter encoding applies only to parameters that are directly bound to a query. Parameters used in Value Expressions (SpEL, Configuration Properties) are not considered for encoding and must be encoded properly by using SpEL Method invocations or a SpEL Extension.

Since:
3.5
Author:
Marcin Grzejszczak, Mark Paluch
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<? extends LdapEncoder>
    value
    LdapEncoder to encode query parameters.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<? extends LdapEncoder>
    encoder
    LdapEncoder to encode query parameters.