PagedResultsResponseControl (Java Platform SE 7 b138)

java.lang.Object
- javax.naming.ldap.BasicControl
- - javax.naming.ldap.PagedResultsResponseControl

All Implemented Interfaces:

Serializable, Control
```
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 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 Also:
PagedResultsControl, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String OID
The paged-results response control's assigned object identifier is 1.2.840.113556.1.4.319.
- Fields inherited from class javax.naming.ldap.BasicControl
  criticality, id, value
- Fields inherited from interface javax.naming.ldap.Control
  CRITICAL, NONCRITICAL

Fields
Modifier and Type	Field and Description
`static String`	`OID` The paged-results response control's assigned object identifier is 1.2.840.113556.1.4.319.

Constructor Summary

Constructors
Constructor and Description

PagedResultsResponseControl(String id, boolean criticality, byte[] value)
Constructs a paged-results response control.

Constructors
Constructor and Description
`PagedResultsResponseControl(String id, boolean criticality, byte[] value)` Constructs a paged-results response control.

Method Summary

Methods
Modifier and Type	Method and Description
`byte[]`	`getCookie()` Retrieves the server-generated cookie.
`int`	`getResultSize()` Retrieves (an estimate of) the number of entries in the search result.

Methods inherited from class javax.naming.ldap.BasicControl
getEncodedValue, getID, isCritical

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OID
```
public static final String OID
```
    The paged-results response control's assigned object identifier is 1.2.840.113556.1.4.319.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - PagedResultsResponseControl
```
public PagedResultsResponseControl(String id,
                           boolean criticality,
                           byte[] value)
                            throws IOException
```
    Constructs a paged-results response control.
    
    Parameters:
    id - The control's object identifier string.
    criticality - The control's criticality.
    value - The control's ASN.1 BER encoded value. It is not cloned - any changes to value will affect the contents of the control.
    
    Throws:
    
    IOException - If an error was encountered while decoding the control's value.
- Method Detail
  - getResultSize
```
public int getResultSize()
```
    Retrieves (an estimate of) the number of entries in the search result.
    
    Returns:
    The number of entries in the search result, or zero if unknown.
  - getCookie
```
public byte[] getCookie()
```
    Retrieves the server-generated cookie. Null is returned when there are no more entries for the server to return.
    
    Returns:
    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.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138

Class PagedResultsResponseControl

Field Summary

Fields inherited from class javax.naming.ldap.BasicControl

Fields inherited from interface javax.naming.ldap.Control

Constructor Summary

Method Summary

Methods inherited from class javax.naming.ldap.BasicControl

Methods inherited from class java.lang.Object

Field Detail

OID

Constructor Detail

PagedResultsResponseControl

Method Detail

getResultSize

getCookie