javax.naming.ldap

Class SortResponseControl

Table des matières
  • All Implemented Interfaces:
    Serializable, Control

    public final class SortResponseControl
extends BasicControl
    Indicates whether the requested sort of search results was successful or not. When the result code indicates success then the results have been sorted as requested. Otherwise the sort was unsuccessful and additional details regarding the cause of the error may have been provided by the server.

    The code sample in SortControl shows how this class may be used.

    This class implements the LDAPv3 Response Control for server-side sorting as defined in RFC 2891. The control's value has the following ASN.1 definition: 

    
     SortResult ::= SEQUENCE {
        sortResult  ENUMERATED {
            success                   (0), -- results are sorted
            operationsError           (1), -- server internal failure
            timeLimitExceeded         (3), -- timelimit reached before
                                           -- sorting was completed
            strongAuthRequired        (8), -- refused to return sorted
                                           -- results via insecure
                                           -- protocol
            adminLimitExceeded       (11), -- too many matching entries
                                           -- for the server to sort
            noSuchAttribute          (16), -- unrecognized attribute
                                           -- type in sort key
            inappropriateMatching    (18), -- unrecognized or inappro-
                                           -- priate matching rule in
                                           -- sort key
            insufficientAccessRights (50), -- refused to return sorted
                                           -- results to this client
            busy                     (51), -- too busy to process
            unwillingToPerform       (53), -- unable to sort
            other                    (80)
            },
      attributeType [0] AttributeType OPTIONAL }
    Since:
    1.5
    See Also:
    SortControl, Serialized Form

    • Field Detail

      • OID

        public static final String OID
        The server-side sort response control's assigned object identifier is 1.2.840.113556.1.4.474.
        See Also:
        Constant Field Values

    • Constructor Detail

      • SortResponseControl

        public SortResponseControl(String id,
                   boolean criticality,
                   byte[] value)
                    throws IOException
        Constructs a control to indicate the outcome of a sort request.
        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 is encountered while decoding the control's value.

    • Method Detail

      • isSorted

        public boolean isSorted()
        Determines if the search results have been successfully sorted. If an error occurred during sorting a NamingException is thrown.
        Returns:
        true if the search results have been sorted.

      • getResultCode

        public int getResultCode()
        Retrieves the LDAP result code of the sort operation.
        Returns:
        The result code. A zero value indicates success.

      • getAttributeID

        public String getAttributeID()
        Retrieves the ID of the attribute that caused the sort to fail. Returns null if no ID was returned by the server.
        Returns:
        The possibly null ID of the bad attribute.

      • getException

        public NamingException getException()
        Retrieves the NamingException appropriate for the result code.
        Returns:
        A NamingException or null if the result code indicates success.

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

21/11/2024 21:51:21 Cette version de la page est en cache (à la date du 21/11/2024 21:51:21) 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 30/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/naming/ldap/sortresponsecontrol.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, SortResponseControl

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