Java Doc for SortResponseControl.java in  » 6.0-JDK-Core » naming » javax » naming » ldap » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » naming » javax.naming.ldap 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.naming.ldap.BasicControl
      javax.naming.ldap.SortResponseControl

SortResponseControl
final public class SortResponseControl extends BasicControl (Code)
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
author:
   Vincent Ryan


Field Summary
final public static  StringOID
     The server-side sort response control's assigned object identifier is 1.2.840.113556.1.4.474.

Constructor Summary
public  SortResponseControl(String id, boolean criticality, byte[] value)
     Constructs a control to indicate the outcome of a sort request.

Method Summary
public  StringgetAttributeID()
     Retrieves the ID of the attribute that caused the sort to fail.
public  NamingExceptiongetException()
     Retrieves the NamingException appropriate for the result code.
public  intgetResultCode()
     Retrieves the LDAP result code of the sort operation. The result code.
public  booleanisSorted()
     Determines if the search results have been successfully sorted.

Field Detail
OID
final public static String OID(Code)
The server-side sort response control's assigned object identifier is 1.2.840.113556.1.4.474.




Constructor Detail
SortResponseControl
public SortResponseControl(String id, boolean criticality, byte[] value) throws IOException(Code)
Constructs a control to indicate the outcome of a sort request.
Parameters:
  id - The control's object identifier string.
Parameters:
  criticality - The control's criticality.
Parameters:
  value - The control's ASN.1 BER encoded value.It is not cloned - any changes to valuewill affect the contents of the control.
exception:
  IOException - if an error is encounteredwhile decoding the control's value.




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



getException
public NamingException getException()(Code)
Retrieves the NamingException appropriate for the result code. A NamingException or null if the result code indicatessuccess.



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



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



Fields inherited from javax.naming.ldap.BasicControl
protected boolean criticality(Code)(Java Doc)
protected String id(Code)(Java Doc)
protected byte[] value(Code)(Java Doc)

Methods inherited from javax.naming.ldap.BasicControl
public byte[] getEncodedValue()(Code)(Java Doc)
public String getID()(Code)(Java Doc)
public boolean isCritical()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.