クラスPagedResultsControl

java.lang.Object
javax.naming.ldap.BasicControl
javax.naming.ldap.PagedResultsControl
すべての実装されたインタフェース:
Serializable, Control
public final class PagedResultsControl extends BasicControl
検索操作の結果を、指定したサイズごとにまとめて返すようLDAPサーバーに要求します。 要求者は、検索操作を呼び出す頻度を制御することで、結果を受け取る頻度を制御できます。

このクラスの使用方法を示すコーディング例を次に示します。 


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

    // Activate paged results
    int pageSize = 20; // 20 entries per page
    byte[] cookie = null;
    int total;
    ctx.setRequestControls(new Control[]{
        new PagedResultsControl(pageSize, Control.CRITICAL) });

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

        // Iterate over a batch of 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 paged results control response
        Control[] controls = ctx.getResponseControls();
        if (controls != null) {
            for (int i = 0; i < controls.length; i++) {
                if (controls[i] instanceof PagedResultsResponseControl) {
                    PagedResultsResponseControl prrc =
                        (PagedResultsResponseControl)controls[i];
                    total = prrc.getResultSize();
                    cookie = prrc.getCookie();
                } else {
                    // Handle other response controls (if any)
                }
            }
        }

        // Re-activate paged results
        ctx.setRequestControls(new Control[]{
            new PagedResultsControl(pageSize, cookie, Control.CRITICAL) });
    } while (cookie != null);

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

このクラスは、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
    非クリティカル・コントロールを示します。

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

    コンストラクタ
    コンストラクタ
    説明
    PagedResultsControl(int pageSize, boolean criticality)
    1ページ当たりに取得する結果のエントリ数を設定するためのコントロールを構築します。
    PagedResultsControl(int pageSize, byte[] cookie, boolean criticality)
    1ページ当たりに取得する結果のエントリ数を設定するためのコントロールを構築します。

  • メソッドのサマリー

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

  • コンストラクタの詳細

    • PagedResultsControl

      public PagedResultsControl(int pageSize, boolean criticality) throws IOException
      1ページ当たりに取得する結果のエントリ数を設定するためのコントロールを構築します。
      パラメータ:
      pageSize - 1ページで返すエントリの数。
      criticality - trueの場合、サーバーはこのコントロールに従い、pageSizeで示されたとおりに検索結果を返すか、または検索の実行を拒否する必要がある。 falseの場合、サーバーはこのコントロールに従う必要はない。
      スロー:
      IOException - 指定された引数のコントロールへのエンコード中にエラーが検出された場合。

    • PagedResultsControl

      public PagedResultsControl(int pageSize, byte[] cookie, boolean criticality) throws IOException
      1ページ当たりに取得する結果のエントリ数を設定するためのコントロールを構築します。 Cookieはサーバーによって提供され、ページごとに区切られた結果の応答コントロールから取得できます。

      一連の結果ページを途中で放棄するには、pageSizeを0に設定し、Cookieをサーバーから最後に受け取ったCookieに設定します。

      パラメータ:
      pageSize - 1ページで返すエントリの数。
      cookie - サーバーで生成されたCookie。nullの場合もある。
      criticality - trueの場合、サーバーはこのコントロールに従い、pageSizeで示されたとおりに検索結果を返すか、または検索の実行を拒否する必要がある。 falseの場合、サーバーはこのコントロールに従う必要はない。
      スロー:
      IOException - 指定された引数のコントロールへのエンコード中にエラーが検出された場合。