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

import java.util.List;
import javax.naming.NamingEnumeration;
import javax.naming.NamingException;

/**
 * ResultHandler provides post search processing of ldap results.
 *
 * @param    type of result
 * @param    type of output
 *
 * @author  Middleware Services
 * @version  $Revision: 1330 $
 */
public interface ResultHandler
{


  /**
   * Process the results from an ldap search.
   *
   * @param  sc  SearchCriteria used to perform the search
   * @param  en  NamingEnumeration of search results
   *
   * @return  List of result objects
   *
   * @throws  NamingException  if the LDAP returns an error
   */
  List process(SearchCriteria sc, NamingEnumeration en)
    throws NamingException;


  /**
   * Process the results from an ldap search.
   *
   * @param  sc  SearchCriteria used to perform the search
   * @param  en  NamingEnumeration of search results
   * @param  ignore  Class[] of exception types to ignore results
   *
   * @return  List of result objects
   *
   * @throws  NamingException  if the LDAP returns an error
   */
  List process(
    SearchCriteria sc,
    NamingEnumeration en,
    Class[] ignore)
    throws NamingException;


  /**
   * Process the results from an ldap search.
   *
   * @param  sc  SearchCriteria used to perform the search
   * @param  l  List of search results
   *
   * @return  List of result objects
   *
   * @throws  NamingException  if the LDAP returns an error
   */
  List process(SearchCriteria sc, List l)
    throws NamingException;
}