javax.naming.ldap

Class PagedResultsResponseControl

Table des matières
  • 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 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.

Traduction non disponible

Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.

Version en cache

05/11/2024 20:57:06 Cette version de la page est en cache (à la date du 05/11/2024 20:57:06) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.

Document créé le 06/12/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/naming/ldap/pagedresultsresponsecontrol.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : https://docs.oracle.com, PagedResultsResponseControl

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.

Table des matières Haut