- java.lang.Object
-
- javax.naming.ldap.BasicControl
-
- javax.naming.ldap.SortResponseControl
-
- 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 Summary
Fields Modifier and Type Field and Description static String
OID
The server-side sort response control's assigned object identifier is 1.2.840.113556.1.4.474.-
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 SortResponseControl(String id, boolean criticality, byte[] value)
Constructs a control to indicate the outcome of a sort request.
-
Method Summary
Methods Modifier and Type Method and Description String
getAttributeID()
Retrieves the ID of the attribute that caused the sort to fail.NamingException
getException()
Retrieves the NamingException appropriate for the result code.int
getResultCode()
Retrieves the LDAP result code of the sort operation.boolean
isSorted()
Determines if the search results have been successfully sorted.-
Methods inherited from class javax.naming.ldap.BasicControl
getEncodedValue, getID, isCritical
-
-
-
-
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.
-
-
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/SortResponseControl.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.