edu.vt.middleware.ldap.BaseLdap 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: BaseLdap.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;

import javax.naming.NamingException;

/**
 * BaseLdap provides a base interface for all ldap implementations.
 *
 * @author  Middleware Services
 * @version  $Revision: 1330 $ $Date: 2010-05-23 18:10:53 -0400 (Sun, 23 May 2010) $
 */
public interface BaseLdap
{


  /**
   * This will establish a connection to the ldap.
   *
   * @return  boolean - whether the connection was successfull
   *
   * @throws  NamingException  if the LDAP cannot be reached
   */
  boolean connect()
    throws NamingException;


  /**
   * This will close the connection to the LDAP and establish a new connection.
   *
   * @return  boolean - whether the connection was successfull
   *
   * @throws  NamingException  if the LDAP cannot be reached
   */
  boolean reconnect()
    throws NamingException;


  /** This will close the connection to the LDAP. */
  void close();
}