Package org.springframework.ldap.odm.annotations

Annotation Interface Attribute

@Target(FIELD) @Retention(RUNTIME) public @interface Attribute
This annotation describes the mapping of a Java field to an LDAP attribute.

The containing class must be annotated with Entry.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Attribute.Type
    The Type attribute indicates whether a field is regarded as binary based or string based by the LDAP JNDI provider.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    name
    The LDAP attribute name that this field represents.
    boolean
    readonly
    A boolean parameter to indicate if the attribute should be read only.
    String
    syntax
    The LDAP syntax of the attribute that this field represents.
    Attribute.Type
    type
    Indicates whether this field is returned by the LDAP JNDI provider as a String (Type.STRING) or as a byte[] (Type.BINARY).

  • Element Details

    • name

      String name
      The LDAP attribute name that this field represents.

      Defaults to "" in which case the Java field name is used as the LDAP attribute name.

      Returns:
      The LDAP attribute name.
      Default:
      ""

    • type

      Attribute.Type type
      Indicates whether this field is returned by the LDAP JNDI provider as a String (Type.STRING) or as a byte[] (Type.BINARY).
      Returns:
      Either Type.STRING to indicate a string attribute or Type.BINARY to indicate a binary attribute.
      Default:
      STRING

    • syntax

      String syntax
      The LDAP syntax of the attribute that this field represents.

      This optional value is typically used to affect the precision of conversion of values between LDAP and Java, see ConverterManager and ConverterManagerImpl.

      Returns:
      The LDAP syntax of this attribute.
      Default:
      ""

    • readonly

      boolean readonly
      A boolean parameter to indicate if the attribute should be read only.

      This value allows attributes to be read on read, but not persisted, there are many operational and read-only ldap attributes which will throw errors if they are persisted back to ldap.

      Returns:
      true is the attribute should not be written to ldap.
      Default:
      false