- 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
-
-
Constructor Summary
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
-
-
-
-
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.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/naming/ldap/PagedResultsResponseControl.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.