org.springframework.ldap.odm.annotations.Entry Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-ldap-core Show documentation

spring-ldap-core

There is a newer version: 3.2.4

package org.springframework.ldap.odm.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * This annotation marks a Java class to be persisted in an LDAP directory.
 * 
 * @author Paul Harvey <paul.at.pauls-place.me.uk>
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Entry {
    /**
     * A list of LDAP object classes that the annotated Java class represents.
     * 
     * All fields will be persisted to LDAP unless annotated {@link Transient}.
     * 
     * @return A list of LDAP classes which the annotated Java class represents.
     */
    String[] objectClasses();

    /**
     * The base DN of this entry. If specified, this will be prepended to all calculated
     * distinguished names for entries of the annotated class.
     *
     * @return the base DN for entries of this class
     */
    String base() default "";
}