+ * + * To use paged search you create a "paged search" control that specifies + * the page size and the cookie from last search. You include the control in a + * search request. When a search is performed only a page is returned to the client + * and a new search has to be performed to access the following elements. + *
+ *
+ *
+ * When constructing an LDAPPagedResultsControl object,
+ * you can specify the following information:
+ *
+ * + *
null
+ * for the first page and the server returned value for the following.
+ * + * + * For example: + *
+ * ...
+ * LDAPConnection ld = new LDAPConnection();
+ *
+ * try {
+ * // Connect to server.
+ * ld.connect(3,"ds.example.com", 3389, "cn=Directory Manager", "Secret.123");
+ *
+ * LDAPPagedResultsControl pagecon = new LDAPPagedResultsControl(false, 3);
+ * // Set the search constraints to use that control.
+ * LDAPSearchConstraints cons = new LDAPSearchConstraints();
+ * cons.setBatchSize(1);
+ * cons.setServerControls(pagecon);
+ *
+ * // Start the paged search.
+ * String cookie = null;
+ * int pag = 1;
+ * do{
+ * LDAPSearchResults res = ld.search("ou=certificateRepository,ou=ca,dc=ca,dc=pki,dc=example,dc=com",
+ * LDAPv3.SCOPE_SUB, "(objectClass=certificateRecord)", null, false, cons);
+ *
+ * // Loop through the incoming results.
+ * while (res.hasMoreElements()) {
+ * LDAPEntry entry = res.next();
+ * System.out.println("DN: " + entry.getDN());
+ * }
+ * for (LDAPControl c: res.getResponseControls()){
+ * if(c.getID().equals(LDAPPagedResultsControl.PAGEDSEARCH)){
+ * LDAPPagedResultsControl resC = (LDAPPagedResultsControl) c;
+ * cookie = resC.getCookie();
+ * System.out.println("The control for pag " + pag + " return a total or " + resC.getPageSize() + " and cookie " + resC.getCookie());
+ * if(cookie!=null){
+ * pagecon = new LDAPPagedResultsControl(false, 3, cookie);
+ * cons.setServerControls(pagecon);
+ * }
+ * }
+ * }
+ * pag++;
+ * } while (cookie != null && !cookie.isEmpty());
+ * } catch (Exception e) {
+ * e.printStackTrace();
+ * }
+ *
+ *
+ *
+ *
+ * @see netscape.ldap.LDAPControl
+ *
+ * @author Marco Fargetta LDAPPagedResultsControl object
+ * that specifies a paged search.
+ *
+ * @param oid the oid of this control
+ * @param critical true if this control is critical to the search
+ * @param value the value associated with this control
+ *
+ * @see netscape.ldap.LDAPcontrol
+ *
+ * @throws LDAPException
+ * @throws IOException If value contains an invalid BER sequence.
+ *
+ * @see netscape.ldap.LDAPControl#register
+ */
+ public LDAPPagedResultsControl(String oid, boolean critical, byte[] vals)
+ throws LDAPException, IOException {
+ super(oid, critical, vals);
+ if(!oid.equals(PAGEDSEARCH)) {
+ throw new LDAPException("oid must be LDAPPagedResultsControl.PAGEDSEARCH",
+ LDAPException.PARAM_ERROR);
+ }
+
+ ByteArrayInputStream inStream = new ByteArrayInputStream( vals );
+ JDAPBERTagDecoder decoder = new JDAPBERTagDecoder();
+ int[] nRead = { 0 };
+
+ /* A sequence */
+ BERSequence seq = (BERSequence) BERElement.getElement(decoder, inStream, nRead);
+ m_pageSize = ((BERInteger)seq.elementAt(0)).getValue();
+ if(seq.size() == 1) {
+ return;
+ }
+ BEROctetString t = (BEROctetString)seq.elementAt(1);
+ byte[] cookie = t.getValue();
+ m_cookie = cookie == null ? null : new String(t.getValue(), StandardCharsets.UTF_8);
+ }
+
+ /**
+ * Constructs an LDAPPagedResultsControl object without a cookie.
+ *
+ * This is equivalent to
+ * LDAPPagedResultsControl(critical, pageSize, null)
+ *
+ * @param critical true if this control is critical to the search
+ * @param pageSize the number of entries to be returned with the following
+ * search request
+ *
+ * @see netscape.ldap.LDAPControl
+ */
+ public LDAPPagedResultsControl(boolean critical, int pageSize) {
+ this(critical, pageSize, null);
+ }
+
+ /**
+ * Constructs an LDAPPagedResultsControl.
+ *
+ * @param critical true if this control is critical to the search
+ * @param pageSize the number of entries to be returned with the following
+ * search request
+ * @param cookie The cookie to access the next entries. This is an opaque value
+ * returned by the server or null for the initial search
+ *
+ * @see netscape.ldap.LDAPControl
+ */
+ public LDAPPagedResultsControl(boolean critical, int pageSize, String cookie) {
+ super(PAGEDSEARCH, critical, null);
+ this.m_pageSize = pageSize;
+ this.m_cookie = cookie;
+ m_value = generateNextPageValues(pageSize, cookie);
+ }
+
+ /**
+ * Encode the parameters as requested for the control
+ *
+ * @param pageSize the number of entries to be returned with the following
+ * search request
+ * @param cookie The cookie to access the next entries (it is an opaque value
+ * returned by the server)
+ * @return
+ */
+ private byte[] generateNextPageValues(int pageSize, String cookie) {
+
+ BERSequence seq = new BERSequence();
+ seq.addElement(new BERInteger(pageSize));
+ if(cookie != null) {
+ seq.addElement(new BEROctetString(cookie));
+ } else {
+ seq.addElement(new BEROctetString(""));
+ }
+ BEROctetString controlValue = new BEROctetString(flattenBER(seq));
+ return controlValue.getValue();
+ }
+
+ /**
+ * Gets the page size for the search request.
+ *
+ * @return the number of entries to be returned when a search is requested to the server and
+ * the number of entries available when returned from the server.
+ */
+ public int getPageSize() {
+ return m_pageSize;
+ }
+
+ /**
+ * Gets the cookie for the following search request.
+ *
+ * @return the cookie to use for the following request or null if all entries
+ * have been returned.
+ */
+ public String getCookie() {
+ return m_cookie;
+ }
+}