javax.naming.ldap
類別 SortResponseControl

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

所有已實作的介面：

Serializable, Control

public final class SortResponseControl
extends BasicControl

指示搜尋結果的請求排序是否成功。當結果程式碼指示成功時，結果已按照請求進行了排序。否則，排序失敗，同時伺服器可能提供關於錯誤原因的附加詳細資訊。

SortControl 中的程式碼範例展示了使用此類別的方式。

此類別實作在 RFC 2891 中定義的用於伺服器端排序的 LDAPv3 回應控制元件。 控制元件值具有以下 ASN.1 定義：

     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 }

 

從以下版本開始：

1.5

另請參見：

SortControl, 序列化表格

欄位摘要

static String

OID 伺服器端排序回應控制元件的分派物件標識符為 1.2.840.113556.1.4.474。

從類別 javax.naming.ldap.BasicControl 繼承的欄位

criticality, id, value

從介面 javax.naming.ldap.Control 繼承的欄位

CRITICAL, NONCRITICAL

建構子摘要

SortResponseControl(String id, boolean criticality, byte[] value)
建構一個控制元件來指示排序請求的結果。

方法摘要

String	getAttributeID() 檢索導致排序失敗的屬性的 ID。
NamingException	getException() 檢索適合結果程式碼的 NamingException。
int	getResultCode() 檢索排序操作的 LDAP 結果程式碼。
boolean	isSorted() 確定是否已成功排序搜尋結果。

從類別 javax.naming.ldap.BasicControl 繼承的方法

getEncodedValue, getID, isCritical

從類別 java.lang.Object 繼承的方法

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

欄位詳細資訊

OID

public static final String OID

伺服器端排序回應控制元件的分派物件標識符為 1.2.840.113556.1.4.474。

另請參見：

常數欄位值

建構子詳細資訊

SortResponseControl

public SortResponseControl(String id,
                           boolean criticality,
                           byte[] value)
                    throws IOException

建構一個控制元件來指示排序請求的結果。

參數：

id - 此控制元件的物件標識符字元串。

criticality - 控制元件的關鍵性。

value - 控制元件的 ASN.1 BER 編碼值。它不是副本，對值進行的任何更改都將影響控制元件的內容。

拋出：

IOException - 如果在解碼控制元件值時遇到錯誤。

方法詳細資訊

isSorted

public boolean isSorted()

確定是否已成功排序搜尋結果。如果在排序過程中出錯，則拋出 NamingException。

返回：

如果已排序搜尋結果，則返回 true。

getResultCode

public int getResultCode()

檢索排序操作的 LDAP 結果程式碼。

返回：

結果程式碼。值為零指示成功。

getAttributeID

public String getAttributeID()

檢索導致排序失敗的屬性的 ID。如果伺服器沒有返回任何 ID，則返回 null。

返回：

錯誤屬性的 ID（可能為 null）。

getException

public NamingException getException()

檢索適合結果程式碼的 NamingException。

返回：

如果結果程式碼指示成功，則返回 NamingException 或 null。