Source for gnu.inet.ldap.ResultHandler

   1: /*
   2:  * ResultHandler.java
   3:  * Copyright (C) 2004 The Free Software Foundation
   4:  * 
   5:  * This file is part of GNU inetlib, a library.
   6:  * 
   7:  * GNU inetlib is free software; you can redistribute it and/or modify
   8:  * it under the terms of the GNU General Public License as published by
   9:  * the Free Software Foundation; either version 2 of the License, or
  10:  * (at your option) any later version.
  11:  * 
  12:  * GNU inetlib is distributed in the hope that it will be useful,
  13:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15:  * GNU General Public License for more details.
  16:  * 
  17:  * You should have received a copy of the GNU General Public License
  18:  * along with this library; if not, write to the Free Software
  19:  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20:  * 
  21:  * Linking this library statically or dynamically with other modules is
  22:  * making a combined work based on this library.  Thus, the terms and
  23:  * conditions of the GNU General Public License cover the whole
  24:  * combination.
  25:  *
  26:  * As a special exception, the copyright holders of this library give you
  27:  * permission to link this library with independent modules to produce an
  28:  * executable, regardless of the license terms of these independent
  29:  * modules, and to copy and distribute the resulting executable under
  30:  * terms of your choice, provided that you also meet, for each linked
  31:  * independent module, the terms and conditions of the license of that
  32:  * module.  An independent module is a module which is not derived from
  33:  * or based on this library.  If you modify this library, you may extend
  34:  * this exception to your version of the library, but you are not
  35:  * obliged to do so.  If you do not wish to do so, delete this
  36:  * exception statement from your version.
  37:  */
  38: 
  39: package gnu.inet.ldap;
  40: 
  41: import java.util.List;
  42: import java.util.Map;
  43: 
  44: /**
  45:  * Callback handler for receiving notification of search results.
  46:  * The application must pass an implementation of this interface into the
  47:  * <code>LDAPConnection.search</code> method. Search responses received
  48:  * during the execution of the method result in calls to the methods defined
  49:  * in this interface.
  50:  *
  51:  * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
  52:  */
  53: public interface ResultHandler
  54: {
  55: 
  56:   /**
  57:    * Receive an LDAP SearchResultEntry response.
  58:    * The attributes map provides a mapping of attribute names to values. In
  59:    * the case where <code>typesOnly</code> was <code>true</code>, the value
  60:    * for each attribute will be null. Otherwise it will be a Set of
  61:    * attribute values, which may be of the following types:
  62:    * <ul>
  63:    * <li>java.lang.String</li>
  64:    * <li>java.lang.Integer</li>
  65:    * <li>java.lang.Double</li>
  66:    * <li>java.lang.Boolean</li>
  67:    * <li>byte[]</li>
  68:    * <ul>
  69:    * @param name the object name DN
  70:    * @param attributes a map of attribute names to values
  71:    */
  72:   void searchResultEntry(String name, Map attributes);
  73: 
  74:   /**
  75:    * Receive an LDAP SearchResultReference response.
  76:    * The argument to this function is a sequence of LDAP URLs, one for each
  77:    * entry not explored by the server during the search.
  78:    * @param urls the list of LDAP URLs
  79:    */
  80:   void searchResultReference(List urls);
  81:   
  82: }