org.ldaptive.beans.LdapEntryMapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ldaptive-beans Show documentation

Provides a mapping, persistence, and code generation API for reading and writing POJOs to an LDAP directory

There is a newer version: 2.4.0

/* See LICENSE for licensing and NOTICE for copyright. */
package org.ldaptive.beans;

import org.ldaptive.LdapEntry;

/**
 * Interface for ldap entry mappers.
 *
 * @param    type of object to map
 *
 * @author  Middleware Services
 */
public interface LdapEntryMapper
{


  /**
   * Returns the LDAP DN for the supplied object.
   *
   * @param  object  to retrieve the DN from
   *
   * @return  LDAP DN
   */
  String mapDn(T object);


  /**
   * Injects data from the supplied source object into the supplied ldap entry.
   *
   * @param  source  to read from
   * @param  dest  to write to
   */
  void map(T source, LdapEntry dest);


  /**
   * Injects data from the supplied ldap entry into the supplied destination object.
   *
   * @param  source  to read from
   * @param  dest  to write to
   */
  void map(LdapEntry source, T dest);
}