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

import edu.vt.middleware.ldap.BaseLdap;

/**
 * LdapFactory provides an interface for creating, activating,
 * validating, and destroying ldap objects.
 *
 * @param    type of ldap object
 *
 * @author  Middleware Services
 * @version  $Revision: 1330 $ $Date: 2010-05-23 18:10:53 -0400 (Sun, 23 May 2010) $
 */
public interface LdapFactory
{


  /**
   * Create a new ldap object.
   *
   * @return  ldap object
   */
  T create();


  /**
   * Destroy an ldap object.
   *
   * @param  t  ldap object
   */
  void destroy(T t);


  /**
   * Prepare the supplied object for placement in the pool.
   *
   * @param  t  ldap object
   *
   * @return  whether the supplied object successfully activated
   */
  boolean activate(T t);


  /**
   * Prepare the supplied object for removal from the pool.
   *
   * @param  t  ldap object
   *
   * @return  whether the supplied object successfully passivated
   */
  boolean passivate(T t);


  /**
   * Verify an ldap object is still viable for use in the pool.
   *
   * @param  t  ldap object
   *
   * @return  whether the supplied object is ready for use
   */
  boolean validate(T t);
}