クラス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
関連項目:

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final String
    OID
    サーバー側でのソートの応答コントロールに割り当てられているオブジェクト識別子は1.2.840.113556.1.4.474です。

    クラスで宣言されたフィールド BasicControl

    criticality, id, value
    修飾子と型
    フィールド
    説明
    protected boolean
    criticality
    コントロールのクリティカルの程度。
    protected String
    id
    コントロールのオブジェクト識別子の文字列。
    protected byte[]
    value
    コントロールのASN.1 BERでエンコードされた値。

    インタフェースControlで宣言されたフィールド

    CRITICAL, NONCRITICAL
    修飾子と型
    フィールド
    説明
    static final boolean
    CRITICAL
    クリティカル・コントロールを示します。
    static final boolean
    NONCRITICAL
    非クリティカル・コントロールを示します。

  • コンストラクタのサマリー

    コンストラクタ
    コンストラクタ
    説明
    SortResponseControl(String id, boolean criticality, byte[] value)
    ソート要求の結果を示すためのコントロールを構築します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    String
    getAttributeID()
    ソート失敗の原因となった属性のIDを取得します。
    NamingException
    getException()
    結果コードに適したNamingExceptionを取得します。
    int
    getResultCode()
    ソート操作のLDAP結果コードを取得します。
    boolean
    isSorted()
    検索結果が正常にソートされているかどうかを判定します。

    クラスで宣言されたメソッド BasicControl

    getEncodedValue, getID, isCritical
    修飾子と型
    メソッド
    説明
    byte[]
    getEncodedValue()
    コントロールのASN.1 BERでエンコードされた値を取得します。
    String
    getID()
    コントロールのオブジェクト識別子の文字列を取得します。
    boolean
    isCritical()
    コントロールのクリティカルの程度を判定します。

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    String
    toString()
    オブジェクトの文字列表現を返します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • フィールド詳細

    • 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結果コードを取得します。
      戻り値:
      結果コード。 値0は成功を示す。

    • getAttributeID

      public String getAttributeID()
      ソート失敗の原因となった属性のIDを取得します。 サーバーからIDが返されなかった場合は、nullを返します。
      戻り値:
      原因となった属性のID。nullの場合もある。

    • getException

      public NamingException getException()
      結果コードに適したNamingExceptionを取得します。
      戻り値:
      NamingException。結果コードが成功を示している場合はnull。