SortResponseControl (Java 2 Platform SE 5.0) - JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

概述

软件包

类

使用

树

已过时

索引

帮助

Java^TM 2 Platform
Standard Ed. 5.0

上一个类 下一个类

框架 无框架

摘要：嵌套 | 字段 | 构造方法 | 方法

详细信息：字段 | 构造方法 | 方法

javax.naming.ldap
类 SortResponseControl

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

所有已实现的接口：: Serializable, Control

public final class SortResponseControl
extends BasicControl
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

字段摘要
`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。

另请参见：: 常量字段值

构造方法详细信息