Search by page can be performed using the PagedResultsControl API - Java JNDI

Java examples for JNDI:Search

  1. HOME
  2. Java
  3. JNDI
  4. Search

Description

Search by page can be performed using the PagedResultsControl API

Demo Code

import java.util.Hashtable;
import java.util.Enumeration;
import java.io.IOException;

import javax.naming.*;
import javax.naming.directory.*;
import javax.naming.ldap.*;

/**//  ww  w.  j  a v a 2  s  .c om
 * Shows how a paged search can be performed using the
 * PagedResultsControl API
 */

class PagedSearch {

    public static void main(String[] args) {

        Hashtable<String, Object> env = new Hashtable<String, Object>(11);
        env.put(Context.INITIAL_CONTEXT_FACTORY,
                "com.sun.jndi.ldap.LdapCtxFactory");

        /* Specify host and port to use for directory service */
        env.put(Context.PROVIDER_URL,
                "ldap://localhost:389/ou=People,o=JNDITutorial");

        try {
            LdapContext ctx = new InitialLdapContext(env, null);

            // Activate paged results
            int pageSize = 5;
            byte[] cookie = null;
            ctx.setRequestControls(new Control[] { new PagedResultsControl(
                    pageSize, Control.NONCRITICAL) });
            int total;

            do {
                /* perform the search */
                NamingEnumeration results = ctx.search("",
                        "(objectclass=*)", new SearchControls());

                /* for each entry print out name + all attrs and values */
                while (results != null && results.hasMore()) {
                    SearchResult entry = (SearchResult) results.next();
                    System.out.println(entry.getName());
                }

                // Examine the paged results control response
                Control[] controls = ctx.getResponseControls();
                if (controls != null) {
                    for (int i = 0; i < controls.length; i++) {
                        if (controls[i] instanceof PagedResultsResponseControl) {
                            PagedResultsResponseControl prrc = (PagedResultsResponseControl) controls[i];
                            total = prrc.getResultSize();
                            if (total != 0) {
                                System.out
                                        .println("***************** END-OF-PAGE "
                                                + "(total : "
                                                + total
                                                + ") *****************\n");
                            } else {
                                System.out
                                        .println("***************** END-OF-PAGE "
                                                + "(total: unknown) ***************\n");
                            }
                            cookie = prrc.getCookie();
                        }
                    }
                } else {
                    System.out
                            .println("No controls were sent from the server");
                }
                // Re-activate paged results
                ctx.setRequestControls(new Control[] { new PagedResultsControl(
                        pageSize, cookie, Control.CRITICAL) });

            } while (cookie != null);

            ctx.close();

        } catch (NamingException e) {
            System.err.println("PagedSearch failed.");
            e.printStackTrace();
        } catch (IOException ie) {
            System.err.println("PagedSearch failed.");
            ie.printStackTrace();
        }
    }
}

/*
 * Copyright (c) 1995, 2008, Oracle and/or its affiliates. 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 Oracle or 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.
 */

Related Tutorials