クラス PagedResultsControlExchange
java.lang.ObjectSE
org.springframework.ldap.control.PagedResultsControlExchange
- 実装済みのインターフェース一覧:
ControlExchange<PagedResultsControlSE, PagedResultsResponseControlSE>
public class PagedResultsControlExchange
extends ObjectSE
implements ControlExchange<PagedResultsControlSE, PagedResultsResponseControlSE>
LDAP ページングされた結果のリクエストとレスポンスの制御を管理するための
ControlExchange 実装。 このクラスは、PagedResultsControlSE リクエストと対応する PagedResultsResponseControlSE レスポンスをペアリングします。ページングされた結果コントロールにより、クライアントは指定されたサイズのページで検索結果を取得できます。レスポンスコントロールは、後続のページを取得するための Cookie を提供します。
このクラスのインスタンスは不変です。withResponse(PagedResultsResponseControl) メソッドは、レスポンスから取得したクッキーを含む更新されたリクエストコントロールを備えた新しいインスタンスを返し、次のページリクエストに対応できるようにします。
- 導入:
- 4.1
- 関連事項:
コンストラクター概要
コンストラクター方法の概要
修飾子と型メソッド説明リクエスト制御を返します。@Nullable PagedResultsResponseControlSEレスポンス制御が受信されている場合は、それを返します。withResponse(PagedResultsResponseControlSE response) レスポンスコントロールからのクッキーを含む、更新されたリクエストコントロールを使用して新しいエクスチェンジを作成します。
コンストラクターの詳細
PagedResultsControlExchange
public PagedResultsControlExchange(int pageSize) 指定されたページサイズで新しいページング結果制御交換を構築します- パラメーター:
pageSize- the number of entries to return in each page
方法の詳細
getRequest
リクエスト制御を返します。- 次で指定:
- インターフェース
ControlExchange<PagedResultsControlSE, PagedResultsResponseControlSE>内のgetRequest - 戻り値:
- リクエストコントロール
getResponse
レスポンス制御が受信されている場合は、それを返します。- 次で指定:
- インターフェース
ControlExchange<PagedResultsControlSE, PagedResultsResponseControlSE>内のgetResponse - 戻り値:
- レスポンス制御、またはレスポンスが受信されていない場合は
null
withResponse
レスポンスコントロールからのクッキーを含む、更新されたリクエストコントロールを使用して新しいエクスチェンジを作成します。This method creates a new
PagedResultsControlExchange.SpringLdapPagedResultsControlwith the same page size and criticality as the current request, but with the cookie from the provided response. This prepares the control for requesting the next page of results.- 次で指定:
- インターフェース
ControlExchange<PagedResultsControlSE, PagedResultsResponseControlSE>内のwithResponse - パラメーター:
response- the response control containing the cookie for the next page- 戻り値:
- a new
PagedResultsControlExchangewith the updated request and the provided response