edu.vt.middleware.ldap.bean.LdapEntry Maven / Gradle / Ivy

Go to download

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

Library for performing common LDAP operations

There is a newer version: 3.3.9

/*
  $Id: LdapEntry.java 1330 2010-05-23 22:10:53Z dfisher $

  Copyright (C) 2003-2010 Virginia Tech.
  All rights reserved.

  SEE LICENSE FOR MORE INFORMATION

  Author:  Middleware Services
  Email:   [email protected]
  Version: $Revision: 1330 $
  Updated: $Date: 2010-05-23 18:10:53 -0400 (Sun, 23 May 2010) $
*/
package edu.vt.middleware.ldap.bean;

import javax.naming.NamingException;
import javax.naming.directory.SearchResult;

/**
 * LdapEntry represents a single ldap entry.
 *
 * @author  Middleware Services
 * @version  $Revision: 1330 $ $Date: 2010-05-23 18:10:53 -0400 (Sun, 23 May 2010) $
 */
public interface LdapEntry
{


  /**
   * This returns the DN for this LdapEntry.
   *
   * @return  String
   */
  String getDn();


  /**
   * This returns the LdapAttributes for this 
   * LdapEntry.
   *
   * @return  LdapAttributes
   */
  LdapAttributes getLdapAttributes();


  /**
   * This sets this LdapEntry with the supplied search result.
   *
   * @param  sr  SearchResult
   *
   * @throws  NamingException  if the search result cannot be read
   */
  void setEntry(final SearchResult sr)
    throws NamingException;


  /**
   * This sets the DN for this LdapEntry.
   *
   * @param  dn  String
   */
  void setDn(final String dn);


  /**
   * This sets the attributes for this LdapEntry.
   *
   * @param  a  LdapAttribute
   */
  void setLdapAttributes(final LdapAttributes a);


  /**
   * This returns a SearchResult that represents this entry.
   *
   * @return  SearchResult
   */
  SearchResult toSearchResult();
}