クラスPagedResultsResponseControl

java.lang.Object
javax.naming.ldap.BasicControl
javax.naming.ldap.PagedResultsResponseControl
すべての実装されたインタフェース:
Serializable, Control
public final class PagedResultsResponseControl extends BasicControl
1セットの検索結果が終了したことを示します。 この結果セットにある合計エントリ数の推定値と、不透明Cookieが含まれています。 このCookieは、次の結果セットを取得できるように次の検索操作に渡す必要があります。

PagedResultsControlのコーディング例は、このクラスの使用方法を示しています。

このクラスは、RFC 2696で定義されている、ページごとに区切られた結果のLDAPv3応答コントロールを実装します。 このコントロールの値のASN.1定義は次のとおりです。 


    realSearchControlValue ::= SEQUENCE {
        size      INTEGER (0..maxInt),
                          -- requested page size from client
                          -- result set size estimate from server
        cookie    OCTET STRING
    }

導入されたバージョン:
1.5
関連項目:

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final String
    OID
    ページごとに区切られた結果の応答コントロールに割り当てられているオブジェクト識別子は1.2.840.113556.1.4.319です。

    クラスで宣言されたフィールド 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
    非クリティカル・コントロールを示します。

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

    コンストラクタ
    コンストラクタ
    説明
    PagedResultsResponseControl(String id, boolean criticality, byte[] value)
    ページごとに区切られた結果の応答コントロールを構築します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    byte[]
    getCookie()
    サーバーで生成されたCookieを取得します。
    int
    getResultSize()
    この検索結果にあるエントリ数(推定値)を取得します。

    クラスで宣言されたメソッド 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.319です。
      関連項目:

  • コンストラクタの詳細

    • PagedResultsResponseControl

      public PagedResultsResponseControl(String id, boolean criticality, byte[] value) throws IOException
      ページごとに区切られた結果の応答コントロールを構築します。
      パラメータ:
      id - コントロールのオブジェクト識別子の文字列。
      criticality - コントロールのクリティカルの程度。
      value - コントロールのASN.1 BERでエンコードされた値。 この値は複製されないので、この値を変更するとコントロールの内容に影響する。
      スロー:
      IOException - コントロールの値をデコードするときにエラーが発生した場合。

  • メソッドの詳細

    • getResultSize

      public int getResultSize()
      この検索結果にあるエントリ数(推定値)を取得します。
      戻り値:
      この検索結果にあるエントリ数。不明な場合は0。

    • getCookie

      public byte[] getCookie()
      サーバーで生成されたCookieを取得します。 サーバーにそれ以上エントリがないときは、nullが返されます。
      戻り値:
      サーバーで生成されたCookie。nullの場合もある。 これは複製されないので、このCookieを変更するとコントロールの状態が更新される。したがって、Cookieを変更することは推奨しない。