001 /*
002 * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.naming.ldap;
027
028 import java.io.IOException;
029 import com.sun.jndi.ldap.Ber;
030 import com.sun.jndi.ldap.BerDecoder;
031
032 /**
033 * Indicates the end of a batch of search results.
034 * Contains an estimate of the total number of entries in the result set
035 * and an opaque cookie. The cookie must be supplied to the next search
036 * operation in order to get the next batch of results.
037 * <p>
038 * The code sample in {@link PagedResultsControl} shows how this class may
039 * be used.
040 * <p>
041 * This class implements the LDAPv3 Response Control for
042 * paged-results as defined in
043 * <a href="http://www.ietf.org/rfc/rfc2696">RFC 2696</a>.
044 *
045 * The control's value has the following ASN.1 definition:
046 * <pre>
047 *
048 * realSearchControlValue ::= SEQUENCE {
049 * size INTEGER (0..maxInt),
050 * -- requested page size from client
051 * -- result set size estimate from server
052 * cookie OCTET STRING
053 * }
054 *
055 * </pre>
056 *
057 * @since 1.5
058 * @see PagedResultsControl
059 * @author Vincent Ryan
060 */
061 final public class PagedResultsResponseControl extends BasicControl {
062
063 /**
064 * The paged-results response control's assigned object identifier
065 * is 1.2.840.113556.1.4.319.
066 */
067 public static final String OID = "1.2.840.113556.1.4.319";
068
069 private static final long serialVersionUID = -8819778744844514666L;
070
071 /**
072 * An estimate of the number of entries in the search result.
073 *
074 * @serial
075 */
076 private int resultSize;
077
078 /**
079 * A server-generated cookie.
080 *
081 * @serial
082 */
083 private byte[] cookie;
084
085 /**
086 * Constructs a paged-results response control.
087 *
088 * @param id The control's object identifier string.
089 * @param criticality The control's criticality.
090 * @param value The control's ASN.1 BER encoded value.
091 * It is not cloned - any changes to value
092 * will affect the contents of the control.
093 * @exception IOException If an error was encountered while decoding
094 * the control's value.
095 */
096 public PagedResultsResponseControl(String id, boolean criticality,
097 byte[] value) throws IOException {
098
099 super (id, criticality, value);
100
101 // decode value
102 BerDecoder ber = new BerDecoder(value, 0, value.length);
103
104 ber.parseSeq(null);
105 resultSize = ber.parseInt();
106 cookie = ber.parseOctetString(Ber.ASN_OCTET_STR, null);
107 }
108
109 /**
110 * Retrieves (an estimate of) the number of entries in the search result.
111 *
112 * @return The number of entries in the search result, or zero if unknown.
113 */
114 public int getResultSize() {
115 return resultSize;
116 }
117
118 /**
119 * Retrieves the server-generated cookie. Null is returned when there are
120 * no more entries for the server to return.
121 *
122 * @return A possibly null server-generated cookie. It is not cloned - any
123 * changes to the cookie will update the control's state and thus
124 * are not recommended.
125 */
126 public byte[] getCookie() {
127 if (cookie.length == 0) {
128 return null;
129 } else {
130 return cookie;
131 }
132 }
133 }
|