compact3

javax.naming.ldap

Class SortControl

java.lang.Object

javax.naming.ldap.BasicControl

javax.naming.ldap.SortControl

All Implemented Interfaces:

Serializable， Control

public final class SortControl
extends BasicControl

要求：搜索结果排序的LDAP服务器在返回之前。指定的排序条件是使用一个或多个排序键的有序列表，与相关的排序参数。搜索结果的排序在LDAP服务器根据排序控件提供的参数，然后返回给请求者。如果在服务器（和排序控件标记为关键的）不支持排序，则不执行搜索操作，并返回错误。

下面的代码示例演示如何使用类：

     // Open an LDAP association
     LdapContext ctx = new InitialLdapContext();

     // Activate sorting
     String sortKey = "cn";
     ctx.setRequestControls(new Control[]{
         new SortControl(sortKey, Control.CRITICAL) });

     // Perform a search
     NamingEnumeration results =
         ctx.search("", "(objectclass=*)", new SearchControls());

     // Iterate over search results
     while (results != null && results.hasMore()) {
         // Display an entry
         SearchResult entry = (SearchResult)results.next();
         System.out.println(entry.getName());
         System.out.println(entry.getAttributes());

         // Handle the entry's response controls (if any)
         if (entry instanceof HasControls) {
             // ((HasControls)entry).getControls();
         }
     }
     // Examine the sort control response
     Control[] controls = ctx.getResponseControls();
     if (controls != null) {
         for (int i = 0; i < controls.length; i++) {
             if (controls[i] instanceof SortResponseControl) {
                 SortResponseControl src = (SortResponseControl)controls[i];
                 if (! src.isSorted()) {
                     throw src.getException();
                 }
             } else {
                 // Handle other response controls (if any)
             }
         }
     }

     // Close the LDAP association
     ctx.close();
     ...

 

实现了服务器端排序中定义的RFC 2891 LDAPv3要求控制这类。控制的价值具有以下ASN. 1定义：

sortkeylist：：=序列{序列attributedescription AttributeType，orderingrule [ 0 ] matchingruleid可选，阶[ 1 ]布尔默认错误}

从以下版本开始：

一点五

另请参见：

SortKey， SortResponseControl， Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	OID 服务器端排序控制分配的对象标识符是1.2.840.113556.1.4.473。

Fields inherited from class javax.naming.ldap.BasicControl

criticality, id, value

Fields inherited from interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

构造方法摘要

构造方法

Constructor and Description
SortControl(SortKey[] sortBy, boolean criticality) 构造一个控件来对排序键列表进行排序。
SortControl(String[] sortBy, boolean criticality) 构造一个控件以在一个属性的列表中进行排序。
SortControl(String sortBy, boolean criticality) 构造一个以提升顺序对单个属性进行排序的控件。

方法摘要

Methods inherited from class javax.naming.ldap.BasicControl

getEncodedValue, getID, isCritical

Methods inherited from class java.lang.Object

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

Field Detail

OID

public static final String OID

服务器端排序控制分配的对象标识符是1.2.840.113556.1.4.473。

另请参见：

Constant Field Values

Constructor Detail

SortControl

public SortControl(String sortBy,
                   boolean criticality)
            throws IOException

构造一个以提升顺序对单个属性进行排序的控件。将使用与指定属性的使用定义的排序匹配规则进行排序。

参数

sortBy -属性ID进行排序。

criticality -如果真那么服务器必须控制和返回搜索结果排序的要求或拒绝执行搜索。如果是错误的，那么服务器就不需要控制了。

异常

IOException如果编码提供的参数到控制时出错。

SortControl

public SortControl(String[] sortBy,
                   boolean criticality)
            throws IOException

构造一个控件以在一个属性的列表中进行排序。将使用与每个指定属性中使用的排序匹配规则进行排序。

参数

sortBy -一个非空的列属性ID进行排序。该列表是在最高到最低的排序键优先顺序。

criticality -如果真那么服务器必须控制和返回搜索结果排序的要求或拒绝执行搜索。如果是错误的，那么服务器就不需要控制了。

异常

IOException如果编码提供的参数到控制时出错。

SortControl

public SortControl(SortKey[] sortBy,
                   boolean criticality)
            throws IOException

构造一个控件来对排序键列表进行排序。每个排序键指定使用的排序顺序和排序匹配规则。

参数

sortBy -一个非空的列键排序。该列表是在最高到最低的排序键优先顺序。

criticality -如果真那么服务器必须控制和返回搜索结果排序的要求或拒绝执行搜索。如果是错误的，那么服务器就不需要控制了。

异常

IOException如果编码提供的参数到控制时出错。