com.novell.ldap.controls
Class LDAPPagedResultsControl

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

All Implemented Interfaces:

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

public class LDAPPagedResultsControl
extends LDAPControl

LDAPPagedResultsControl is a Server Control to specify how search results are to be returned in pages of specified size by the server. If the control was marked "critical", the whole search operation will fail if the paged results control is not supported. This control is specified in RFC2696

See Also:

Serialized Form

Field Summary

private byte[]	Cookie
private static byte[]	EMPTY_COOKIE Empty cookie
private int	pageSize
private static java.lang.String	requestOID The requestOID of the paged results control
private static java.lang.String	responseOID The responseOID of the paged results control

Constructor Summary

LDAPPagedResultsControl(int pageSize, boolean critical)
Constructs a paged results control with requested page size

LDAPPagedResultsControl(int pagesize, byte[] cookie, boolean critical)
Constructs a paged results control with requested page size and cookie

Method Summary

byte[]	getCookie() Returns the current cookie
int	getPageSize() Returns the current page size value
void	setCookie(byte[] cookie) Sets new cookie value
private void	setEncodedValue()
void	setPageSize(int pagesize) Sets the request page size value

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

requestOID

private static java.lang.String requestOID

The requestOID of the paged results control

responseOID

private static java.lang.String responseOID

The responseOID of the paged results control

EMPTY_COOKIE

private static final byte[] EMPTY_COOKIE

Empty cookie

pageSize

private int pageSize

Cookie

private byte[] Cookie

Constructor Detail

LDAPPagedResultsControl

public LDAPPagedResultsControl(int pagesize,
                               byte[] cookie,
                               boolean critical)

Constructs a paged results control with requested page size and cookie

Parameters:

pageSize - Requested page size.

Cookie - Paged Results cookie.

critical - True if the search operation is to fail if the server does not support this control.

LDAPPagedResultsControl

public LDAPPagedResultsControl(int pageSize,
                               boolean critical)

Constructs a paged results control with requested page size

Parameters:

pageSize - Requested page size.

critical - True if the search operation is to fail if the server does not support this control.

Method Detail

setEncodedValue

private void setEncodedValue()

getPageSize

public int getPageSize()

Returns the current page size value

setPageSize

public void setPageSize(int pagesize)

Sets the request page size value

Parameters:

pageSize - new page size value

getCookie

public byte[] getCookie()

Returns the current cookie

setCookie

public void setCookie(byte[] cookie)

Sets new cookie value

Parameters:

cookie - new cookie value