javax.naming.ldap

クラス PagedResultsResponseControl

java.lang.Object

javax.naming.ldap.BasicControl

javax.naming.ldap.PagedResultsResponseControl

すべての実装されたインタフェース:

Serializable, Control

public final class PagedResultsResponseControl
extends BasicControl

1 セットの検索結果が終了したことを示します。この結果セットにある合計エントリ数の推定値と、不透明クッキーが含まれています。このクッキーは、次の結果セットを取得できるように次の検索操作に渡す必要があります。

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

関連項目:

PagedResultsControl, 直列化された形式

フィールドのサマリー

フィールド

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

クラス javax.naming.ldap.BasicControl から継承されたフィールド

criticality, id, value

インタフェース javax.naming.ldap.Control から継承されたフィールド

CRITICAL, NONCRITICAL

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

コンストラクタ

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

メソッドのサマリー

メソッド

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

クラス 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.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()

サーバーで生成されたクッキーを取得します。サーバーにそれ以上エントリがないときは、null が返されます。

戻り値:

サーバーで生成されたクッキー。null の場合もある。これは複製されないので、このクッキーを変更するとコントロールの状態が更新される。したがって、クッキーを変更することは推奨しない。