uTools-Manuals/docs/java/javax/naming/ldap/SortResponseControl.html

322 lines
15 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div class="header">
<div class="subTitle">
compact3
</div>
<div class="subTitle">
javax.naming.ldap
</div>
<h2 class="title" title="Class SortResponseControl">Class SortResponseControl</h2>
</div><div class="contentContainer">
<ul class="inheritance">
<li><a href="../../../java/lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../javax/naming/ldap/BasicControl.html" title="class in javax.naming.ldap">javax.naming.ldap.BasicControl</a></li>
<li>
<ul class="inheritance">
<li>javax.naming.ldap.SortResponseControl</li>
</ul> </li>
</ul> </li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>
All Implemented Interfaces:
</dt>
<dd>
<span><a href="../../../java/io/Serializable.html" title="java.io中的接口">Serializable</a> <a href="../../../javax/naming/ldap/Control.html" title="javax.naming.ldap中的接口">Control</a></span>
</dd>
</dl>
<hr/> <br/> <pre>public final class <span class="typeNameLabel">SortResponseControl</span>
extends <a href="../../../javax/naming/ldap/BasicControl.html" title="class in javax.naming.ldap">BasicControl</a></pre>
<div class="block">
<span>指示所请求的搜索结果是否成功。</span>
<span>当结果代码指示成功时,结果已按要求排序。</span>
<span>否则排序不成功,并且有关错误原因的其他详细信息可能已由服务器提供。</span>
<p> <span><a href="../../../javax/naming/ldap/SortControl.html" title="javax.naming.ldap中的类"><code>SortControl</code></a>中的代码示例显示了如何使用这个类。</span> </p>
<p> <span>中所定义的此类实现服务器端排序的LDAPv3的响应控制<a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a></span> <span>控件的值具有以下ASN.1定义:</span> </p>
<pre> <span>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 }</span> </pre>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始:</span>
</dt>
<dd>
1.5
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<span><a href="../../../javax/naming/ldap/SortControl.html" title="javax.naming.ldap中的类"><code>SortControl</code></a> <a href="../../../serialized-form.html#javax.naming.ldap.SortResponseControl">Serialized Form</a></span>
</dd>
</dl> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- --> </a> <h3>Field Summary</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Field Summary table, listing fields, and an explanation">
<caption>
<span>Fields</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/naming/ldap/SortResponseControl.html#OID">OID</a></span></code>
<div class="block">
服务器端排序响应控件的分配对象标识符为1.2.840.113556.1.4.474。
</div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.javax.naming.ldap.BasicControl">
<!-- --> </a> <h3>Fields inherited from class javax.naming.ldap.<a href="../../../javax/naming/ldap/BasicControl.html" title="class in javax.naming.ldap">BasicControl</a></h3> <code><a href="../../../javax/naming/ldap/BasicControl.html#criticality">criticality</a>, <a href="../../../javax/naming/ldap/BasicControl.html#id">id</a>, <a href="../../../javax/naming/ldap/BasicControl.html#value">value</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.javax.naming.ldap.Control">
<!-- --> </a> <h3>Fields inherited from interface javax.naming.ldap.<a href="../../../javax/naming/ldap/Control.html" title="interface in javax.naming.ldap">Control</a></h3> <code><a href="../../../javax/naming/ldap/Control.html#CRITICAL">CRITICAL</a>, <a href="../../../javax/naming/ldap/Control.html#NONCRITICAL">NONCRITICAL</a></code></li>
</ul> </li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- --> </a> <h3>构造方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption>
<span>构造方法</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/naming/ldap/SortResponseControl.html#SortResponseControl-java.lang.String-boolean-byte:A-">SortResponseControl</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> id, boolean criticality, byte[] value)</code>
<div class="block">
构造一个控件来指示排序请求的结果。
</div> </td>
</tr>
</tbody>
</table> </li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- --> </a> <h3>方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption>
<span class="activeTableTab" id="t0"><span>所有方法</span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t2"><span><a href="javascript:show(2);">接口方法</a></span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t4"><span><a href="javascript:show(8);">具体的方法</a></span><span class="tabEnd"> </span></span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor" id="i0">
<td class="colFirst"><code><a href="../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/naming/ldap/SortResponseControl.html#getAttributeID--">getAttributeID</a></span>()</code>
<div class="block">
检索导致排序失败的属性的ID。
</div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../../javax/naming/NamingException.html" title="class in javax.naming">NamingException</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/naming/ldap/SortResponseControl.html#getException--">getException</a></span>()</code>
<div class="block">
检索适合结果代码的NamingException。
</div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/naming/ldap/SortResponseControl.html#getResultCode--">getResultCode</a></span>()</code>
<div class="block">
检索排序操作的LDAP结果代码。
</div> </td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/naming/ldap/SortResponseControl.html#isSorted--">isSorted</a></span>()</code>
<div class="block">
确定搜索结果是否已成功排序。
</div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.naming.ldap.BasicControl">
<!-- --> </a> <h3>Methods inherited from class javax.naming.ldap.<a href="../../../javax/naming/ldap/BasicControl.html" title="class in javax.naming.ldap">BasicControl</a></h3> <code><a href="../../../javax/naming/ldap/BasicControl.html#getEncodedValue--">getEncodedValue</a>, <a href="../../../javax/naming/ldap/BasicControl.html#getID--">getID</a>, <a href="../../../javax/naming/ldap/BasicControl.html#isCritical--">isCritical</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- --> </a> <h3>Methods inherited from class java.lang.<a href="../../../java/lang/Object.html" title="class in java.lang">Object</a></h3> <code><a href="../../../java/lang/Object.html#clone--">clone</a>, <a href="../../../java/lang/Object.html#equals-java.lang.Object-">equals</a>, <a href="../../../java/lang/Object.html#finalize--">finalize</a>, <a href="../../../java/lang/Object.html#getClass--">getClass</a>, <a href="../../../java/lang/Object.html#hashCode--">hashCode</a>, <a href="../../../java/lang/Object.html#notify--">notify</a>, <a href="../../../java/lang/Object.html#notifyAll--">notifyAll</a>, <a href="../../../java/lang/Object.html#toString--">toString</a>, <a href="../../../java/lang/Object.html#wait--">wait</a>, <a href="../../../java/lang/Object.html#wait-long-">wait</a>, <a href="../../../java/lang/Object.html#wait-long-int-">wait</a></code></li>
</ul> </li>
</ul> </li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- --> </a> <h3>字段详细信息</h3> <a name="OID">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>OID</h4> <pre>public static final <a href="../../../java/lang/String.html" title="class in java.lang">String</a> OID</pre>
<div class="block">
服务器端排序响应控件的分配对象标识符为1.2.840.113556.1.4.474。
</div>
<dl>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../constant-values.html#javax.naming.ldap.SortResponseControl.OID">Constant Field Values</a>
</dd>
</dl> </li>
</ul> </li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- --> </a> <h3>构造方法详细信息</h3> <a name="SortResponseControl-java.lang.String-boolean-byte:A-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>SortResponseControl</h4> <pre>public SortResponseControl(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> id,
boolean criticality,
byte[] value)
throws <a href="../../../java/io/IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">
构造一个控件来指示排序请求的结果。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>id</code> - 控件的对象标识符字符串。
</dd>
<dd>
<code>criticality</code> - 控制的关键性。
</dd>
<dd>
<span><code>value</code> - 控制的ASN.1 BER编码值。</span>
<span>它不被克隆 - 任何值的更改将影响控件的内容。</span>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../java/io/IOException.html" title="class in java.io">IOException</a></code> - 如果在解码控件的值时遇到错误。
</dd>
</dl> </li>
</ul> </li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- --> </a> <h3>方法详细信息</h3> <a name="isSorted--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>isSorted</h4> <pre>public boolean isSorted()</pre>
<div class="block">
<span>确定搜索结果是否已成功排序。</span>
<span>如果在排序期间发生错误则抛出NamingException。</span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
如果搜索结果已排序则为true。
</dd>
</dl> </li>
</ul> <a name="getResultCode--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getResultCode</h4> <pre>public int getResultCode()</pre>
<div class="block">
检索排序操作的LDAP结果代码。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>结果代码。</span>
<span>零值表示成功。</span>
</dd>
</dl> </li>
</ul> <a name="getAttributeID--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getAttributeID</h4> <pre>public <a href="../../../java/lang/String.html" title="class in java.lang">String</a> getAttributeID()</pre>
<div class="block">
<span>检索导致排序失败的属性的ID。</span>
<span>如果服务器没有返回ID则返回null。</span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
可能为null的不良属性的ID。
</dd>
</dl> </li>
</ul> <a name="getException--">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>getException</h4> <pre>public <a href="../../../javax/naming/NamingException.html" title="class in javax.naming">NamingException</a> getException()</pre>
<div class="block">
检索适合结果代码的NamingException。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
A NamingException or null if the result code indicates success.
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>