1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
package org.springframework.ldap.odm.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* This annotation describes the mapping of a Java field to an LDAP attribute.
* <p>
* The containing class must be annotated with {@link Entry}.
*
* @author Paul Harvey <paul.at.pauls-place.me.uk>
* @see Entry
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Attribute {
/**
* The Type attribute indicates whether a field is regarded as binary based
* or string based by the LDAP JNDI provider.
*/
enum Type {
/**
* A string field - returned by the JNDI LDAP provider as a {@link java.lang.String}.
*/
STRING, /**
* A binary field - returned by the JNDI LDAP provider as a <code>byte[]</code>.
*/
BINARY
}
/**
* The LDAP attribute name that this field represents.
* <p>
* Defaults to "" in which case the Java field name is used as the LDAP attribute name.
*
* @return The LDAP attribute name.
*
*/
String name() default "";
/**
* Indicates whether this field is returned by the LDAP JNDI provider as a
* <code>String</code> (<code>Type.STRING</code>) or as a
* <code>byte[]</code> (<code>Type.BINARY</code>).
*
* @return Either <code>Type.STRING</code> to indicate a string attribute
* or <code>Type.BINARY</code> to indicate a binary attribute.
*/
Type type() default Type.STRING;
/**
* The LDAP syntax of the attribute that this field represents.
* <p>
* This optional value is typically used to affect the precision of conversion
* of values between LDAP and Java,
* see {@link org.springframework.ldap.odm.typeconversion.ConverterManager}
* and {@link org.springframework.ldap.odm.typeconversion.impl.ConverterManagerImpl}.
*
* @return The LDAP syntax of this attribute.
*/
String syntax() default "";
}
|
