Annotation 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 ClassesModifier and TypeClassDescriptionstatic enum
The Type attribute indicates whether a field is regarded as binary based or string based by the LDAP JNDI provider. -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionThe LDAP attribute name that this field represents.boolean
A boolean parameter to indicate if the attribute should be read only.The LDAP syntax of the attribute that this field represents.Indicates whether this field is returned by the LDAP JNDI provider as aString
(Type.STRING
) or as abyte[]
(Type.BINARY
).
-
Element Details
-
name
String nameThe 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 typeIndicates whether this field is returned by the LDAP JNDI provider as aString
(Type.STRING
) or as abyte[]
(Type.BINARY
).- Returns:
- Either
Type.STRING
to indicate a string attribute orType.BINARY
to indicate a binary attribute.
- Default:
- STRING
-
syntax
String syntaxThe 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
andConverterManagerImpl
.- Returns:
- The LDAP syntax of this attribute.
- Default:
- ""
-
readonly
boolean readonlyA 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
-