com.novell.ldap.controls
Class LDAPPagedResultsResponse

java.lang.Object
  com.novell.ldap.LDAPControl
      com.novell.ldap.controls.LDAPPagedResultsResponse

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class LDAPPagedResultsResponse
extends LDAPControl

LDAPPagedResultsResponse - response to LDAPPagedResultsControl as defined in RFC2696.

See Also:

Serialized Form

Field Summary

private byte[]	Cookie
private int	resultSize

Constructor Summary

LDAPPagedResultsResponse(java.lang.String oid, boolean critical, byte[] values)
This constructor is usually called by the SDK to instantiate an a LDAPControl corresponding to the Server response to a LDAP Control request.

Method Summary

byte[]	getCookie() Returns the cookie that can be used in subsequent searches to retrieve next page.
int	getResultSize() Returns the result size.

Methods inherited from class com.novell.ldap.LDAPControl

clone, getID, getValue, isCritical, readDSML, readExternal, register, setValue, toString, writeDSML, writeExternal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

resultSize

private int resultSize

Cookie

private byte[] Cookie

Constructor Detail

LDAPPagedResultsResponse

public LDAPPagedResultsResponse(java.lang.String oid,
                                boolean critical,
                                byte[] values)
                         throws java.io.IOException

This constructor is usually called by the SDK to instantiate an a LDAPControl corresponding to the Server response to a LDAP Control request. Application programmers should not have any reason to call the constructor. This constructor besides constructing a LDAPControl object parses the contents of the response control.

Parameters:

oid - The OID of the control, as a dotted string.

critical - True if the LDAP operation should be discarded if the control is not supported. False if the operation can be processed without the control.

values - The control-specific data.

Throws:

java.io.IOException

Method Detail

getResultSize

public int getResultSize()

Returns the result size. According to RFC2696, if server does not know this, it may contain 0.

getCookie

public byte[] getCookie()

Returns the cookie that can be used in subsequent searches to retrieve next page.