FileDocCategorySizeDatePackage
PagedResultsResponseControl.javaAPI DocJava SE 5 API3450Fri Aug 26 14:57:40 BST 2005javax.naming.ldap

PagedResultsResponseControl

public final class PagedResultsResponseControl extends BasicControl
Indicates the end of a batch of search results. Contains an estimate of the total number of entries in the result set and an opaque cookie. The cookie must be supplied to the next search operation in order to get the next batch of results.

The code sample in {@link PagedResultsControl} shows how this class may be used.

This class implements the LDAPv3 Response Control for paged-results as defined in RFC 2696. The control's value has the following ASN.1 definition: 


realSearchControlValue ::= SEQUENCE {
size INTEGER (0..maxInt),
-- requested page size from client
-- result set size estimate from server
cookie OCTET STRING
}
since
1.5
see
PagedResultsControl
author
Vincent Ryan

Fields Summary
public static final String
OID
The paged-results response control's assigned object identifier is 1.2.840.113556.1.4.319.
private static final long
serialVersionUID
private int
resultSize
An estimate of the number of entries in the search result.
private byte[]
cookie
A server-generated cookie.
Constructors Summary
public PagedResultsResponseControl(String id, boolean criticality, byte[] value)
Constructs a paged-results response control.

param
id The control's object identifier string.
param
criticality The control's criticality.
param
value The control's ASN.1 BER encoded value. It is not cloned - any changes to value will affect the contents of the control.
exception
IOException If an error was encountered while decoding the control's value.


                                                                                                                                                                            
        
            

        super(id, criticality, value);

        // decode value
        BerDecoder ber = new BerDecoder(value, 0, value.length);

        ber.parseSeq(null);
        resultSize = ber.parseInt();
	cookie = ber.parseOctetString(Ber.ASN_OCTET_STR, null);
Methods Summary
public byte[]getCookie()
Retrieves the server-generated cookie. Null is returned when there are no more entries for the server to return.

return
A possibly null server-generated cookie. It is not cloned - any changes to the cookie will update the control's state and thus are not recommended.

	if (cookie.length == 0) {
	    return null;
	} else {
            return cookie;
	}
public intgetResultSize()
Retrieves (an estimate of) the number of entries in the search result.

return
The number of entries in the search result, or zero if unknown.

        return resultSize;