SortResponseControl (Java 2 Platform SE 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`

フィールドの詳細

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 - コントロールの値を復号化するときにエラーが発生した場合