org.springframework.ldap.odm.annotations

Annotation Type DnAttribute

@Target(value=FIELD)
@Retention(value=RUNTIME)
public @interface DnAttribute

Indicates that a field is to be automatically populated to/from the distinguished name of an entry. Fields annotated with this annotation will be automatically populated with values from the distinguished names of found entries.

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

Author:

Mattias Hellborg Arthursson

Required Element Summary

Required Elements

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

Optional Element Summary

Optional Elements

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

Element Detail

value

public abstract String value

The name of the distinguished name attribute.

Returns:

the attribute name.

index

public abstract 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