Annotation Type 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:
    Entry
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String name
      The LDAP attribute name that this field represents.
      boolean readonly
      A boolean parameter to indicate if the attribute should be read only.
      java.lang.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 Detail

      • name

        java.lang.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:
        org.springframework.ldap.odm.annotations.Attribute.Type.STRING
      • syntax

        java.lang.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