Package org.springframework.ldap.odm.annotations

Annotation Interface DnAttribute

@Target(FIELD) @Retention(RUNTIME) public @interface DnAttribute
Maps a Java field to a component of an entry's distinguished name. Fields annotated with this annotation will be automatically populated with values from the distinguished names of found entries. Annotated fields must be of type String.

For automatic calculation of the DN of an entry to work, the index() value must be specified on all DnAttribute annotations in that class, and these attribute values, prepended with the Entry.base() value will be used to figure out the distinguished name of entries to create and update.

Since:
2.0

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    The name of the distinguished name attribute.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    index
    The index of this attribute in the calculated distinguished name of an entry.

  • Element Details

    • value

      String value
      The name of the distinguished name attribute.
      Returns:
      the attribute name.

    • index

      int index
      The index of this attribute in the calculated distinguished name of an entry.
      Returns:
      the 0-based index of this attribute.
      Default:
      -1