Java by API/javax.naming.directory/SearchControls

new SearchControls()

  

import java.util.Enumeration;
import java.util.Hashtable;
import javax.naming.Context;
import javax.naming.NamingEnumeration;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
import javax.naming.directory.DirContext;
import javax.naming.directory.InitialDirContext;
import javax.naming.directory.SearchControls;
import javax.naming.directory.SearchResult;
public class Main {
  public static String INITCTX = "com.sun.jndi.ldap.LdapCtxFactory";
  public static String MY_HOST = "ldap://localhost:1389";
  public static String MY_SEARCHBASE = "o=server.ru";
  public static String MY_FILTER = "(sn=Carter)";
  public static String MY_ATTRS[] = { "cn", "mail" };
  public static void main(String args[]) throws Exception {
    Hashtable env = new Hashtable();
    env.put(Context.INITIAL_CONTEXT_FACTORY, INITCTX);
    env.put(Context.PROVIDER_URL, MY_HOST);
    DirContext ctx = new InitialDirContext(env);
    SearchControls constraints = new SearchControls();
    constraints.setSearchScope(SearchControls.SUBTREE_SCOPE);
    NamingEnumeration results = ctx.search(MY_SEARCHBASE, MY_FILTER, constraints);
    while (results != null && results.hasMore()) {
      SearchResult sr = (SearchResult) results.next();
      String dn = sr.getName() + ", " + MY_SEARCHBASE;
      System.out.println("Distinguished Name is " + dn);
      Attributes ar = ctx.getAttributes(dn, MY_ATTRS);
      if (ar == null) {
        System.out.println("Entry " + dn + " has none of the specified attributes\n");
        return;
      }
      for (int i = 0; i < MY_ATTRS.length; i++) {
        Attribute attr = ar.get(MY_ATTRS[i]);
        if (attr == null) {
          continue;
        }
        System.out.println(MY_ATTRS[i] + ":");
        for (Enumeration vals = attr.getAll(); vals.hasMoreElements();) {
          System.out.println("\t" + vals.nextElement());
        }
      }
    }
  }
}

SearchControls: setReturningAttributes(String[] attrs)

  
/*
 * Copyright (c) 1995 - 2008 Sun Microsystems, Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   - Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 *   - Neither the name of Sun Microsystems nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
import java.util.Hashtable;
import javax.naming.Context;
import javax.naming.NamingEnumeration;
import javax.naming.directory.DirContext;
import javax.naming.directory.InitialDirContext;
import javax.naming.directory.SearchControls;
/**
 * Demonstrates how to perform a search by specifying a search filter and search
 * controls to search a subtree.
 * 
 * usage: java SearchSubtree
 */
class SearchSubtree {
  public static void main(String[] args) {
    // Set up the environment for creating the initial context
    Hashtable<String, Object> env = new Hashtable<String, Object>(11);
    env
        .put(Context.INITIAL_CONTEXT_FACTORY,
            "com.sun.jndi.ldap.LdapCtxFactory");
    env.put(Context.PROVIDER_URL, "ldap://localhost:389/o=JNDITutorial");
    try {
      // Create initial context
      DirContext ctx = new InitialDirContext(env);
      // Specify the ids of the attributes to return
      String[] attrIDs = { "sn", "telephonenumber", "golfhandicap", "mail" };
      SearchControls ctls = new SearchControls();
      ctls.setReturningAttributes(attrIDs);
      ctls.setSearchScope(SearchControls.SUBTREE_SCOPE);
      // Specify the search filter to match
      // Ask for objects with attribute sn == Geisel and which have
      // the "mail" attribute.
      String filter = "(&(sn=Geisel)(mail=*))";
      // Search subtree for objects using filter
      NamingEnumeration answer = ctx.search("", filter, ctls);
      // Print the answer
      // Search.printSearchEnumeration(answer);
      // Close the context when we"re done
      ctx.close();
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

SearchControls: setSearchScope(int scope)

  

import java.util.Enumeration;
import java.util.Hashtable;
import javax.naming.Context;
import javax.naming.NamingEnumeration;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
import javax.naming.directory.DirContext;
import javax.naming.directory.InitialDirContext;
import javax.naming.directory.SearchControls;
import javax.naming.directory.SearchResult;
public class Main {
  public static String INITCTX = "com.sun.jndi.ldap.LdapCtxFactory";
  public static String MY_HOST = "ldap://localhost:1389";
  public static String MY_SEARCHBASE = "o=server.ru";
  public static String MY_FILTER = "(sn=Carter)";
  public static String MY_ATTRS[] = { "cn", "mail" };
  public static void main(String args[]) throws Exception {
    Hashtable env = new Hashtable();
    env.put(Context.INITIAL_CONTEXT_FACTORY, INITCTX);
    env.put(Context.PROVIDER_URL, MY_HOST);
    DirContext ctx = new InitialDirContext(env);
    SearchControls constraints = new SearchControls();
    constraints.setSearchScope(SearchControls.SUBTREE_SCOPE);
    NamingEnumeration results = ctx.search(MY_SEARCHBASE, MY_FILTER, constraints);
    while (results != null && results.hasMore()) {
      SearchResult sr = (SearchResult) results.next();
      String dn = sr.getName() + ", " + MY_SEARCHBASE;
      System.out.println("Distinguished Name is " + dn);
      Attributes ar = ctx.getAttributes(dn, MY_ATTRS);
      if (ar == null) {
        System.out.println("Entry " + dn + " has none of the specified attributes\n");
        return;
      }
      for (int i = 0; i < MY_ATTRS.length; i++) {
        Attribute attr = ar.get(MY_ATTRS[i]);
        if (attr == null) {
          continue;
        }
        System.out.println(MY_ATTRS[i] + ":");
        for (Enumeration vals = attr.getAll(); vals.hasMoreElements();) {
          System.out.println("\t" + vals.nextElement());
        }
      }
    }
  }
}

SearchControls.SUBTREE_SCOPE

  
/*
 * Copyright (c) 1995 - 2008 Sun Microsystems, Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   - Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 *   - Neither the name of Sun Microsystems nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
import java.util.Hashtable;
import javax.naming.Context;
import javax.naming.NamingEnumeration;
import javax.naming.directory.DirContext;
import javax.naming.directory.InitialDirContext;
import javax.naming.directory.SearchControls;
/**
 * Demonstrates how to perform a search by specifying a search filter and search
 * controls to search a subtree.
 * 
 * usage: java SearchSubtree
 */
class SearchSubtree {
  public static void main(String[] args) {
    // Set up the environment for creating the initial context
    Hashtable<String, Object> env = new Hashtable<String, Object>(11);
    env
        .put(Context.INITIAL_CONTEXT_FACTORY,
            "com.sun.jndi.ldap.LdapCtxFactory");
    env.put(Context.PROVIDER_URL, "ldap://localhost:389/o=JNDITutorial");
    try {
      // Create initial context
      DirContext ctx = new InitialDirContext(env);
      // Specify the ids of the attributes to return
      String[] attrIDs = { "sn", "telephonenumber", "golfhandicap", "mail" };
      SearchControls ctls = new SearchControls();
      ctls.setReturningAttributes(attrIDs);
      ctls.setSearchScope(SearchControls.SUBTREE_SCOPE);
      // Specify the search filter to match
      // Ask for objects with attribute sn == Geisel and which have
      // the "mail" attribute.
      String filter = "(&(sn=Geisel)(mail=*))";
      // Search subtree for objects using filter
      NamingEnumeration answer = ctx.search("", filter, ctls);
      // Print the answer
      // Search.printSearchEnumeration(answer);
      // Close the context when we"re done
      ctx.close();
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}