インターフェース ControlExchange<S extends ControlSE, T extends ControlSE>

型パラメーター:
S - リクエストの種類 ControlSE
T - レスポンスの型 ControlSE
すべての既知の実装クラス:
PagedResultsControlExchange, SortControlExchange
public interface ControlExchange<S extends ControlSE, T extends ControlSE>
LDAP リクエストとレスポンスの制御の交換を表します。

このインターフェースは、LDAP コントロールのライフサイクルを管理するための契約を定義し、リクエスト ControlSE とそれに対応するレスポンス ControlSE をペアリングします。実装は通常不変であり、withResponse(Control) メソッドはレスポンスコントロールを含む新しいインスタンスを返します。

ControlExchangeDirContextProcessor は、LDAP 操作全体にわたる制御を管理するために制御交換を使用します。特に、連続するリクエスト間で情報を維持する必要があるステートフルな制御（ページングされた結果やサーバー側のソートなど）に使用されます。

導入:
4.1
関連事項:

  • 方法の概要

    修飾子と型
    メソッド
    説明
    S
    getRequest()
    リクエスト制御を返します。
    @Nullable T
    getResponse()
    レスポンス制御が受信されている場合は、それを返します。
    ControlExchange<S,T>
    withResponse(T response)
    指定されたレスポンス制御を使用して、新しい交換を作成します。

  • 方法の詳細

    • getRequest

      S getRequest()
      リクエスト制御を返します。
      戻り値:
      リクエストコントロール

    • getResponse

      @Nullable T getResponse()
      レスポンス制御が受信されている場合は、それを返します。
      戻り値:
      レスポンス制御、またはレスポンスが受信されていない場合は null 

    • withResponse

      ControlExchange<S,T> withResponse(T response)
      指定されたレスポンス制御を使用して、新しい交換を作成します。

      実装では通常、更新されたレスポンスを使用して新しいインスタンスを作成し、不変性を維持します。また、レスポンスからの情報に基づいてリクエスト制御を更新する実装もあります（ページングされた結果のために Cookie をコピーするなど）。

      パラメーター:
      response - 新しい交換に含めるレスポンス制御
      戻り値:
      レスポンス付きの新しい ControlExchange