パッケージ org.springframework.ldap.control

クラス AbstractRequestControlDirContextProcessor

java.lang.ObjectSE
org.springframework.ldap.control.AbstractRequestControlDirContextProcessor
実装されているすべてのインターフェース:
DirContextProcessor
既知の直属サブクラス
AbstractFallbackRequestAndResponseControlDirContextProcessor, PagedResultsRequestControl
public abstract class AbstractRequestControlDirContextProcessor extends ObjectSE implements DirContextProcessor
LdapContext に単一の RequestControl を適用し、既存のコントロールを保持する責任を持つ抽象スーパークラス。サブクラスは DirContextProcessor.postProcess(DirContext) とテンプレートメソッド createRequestControl() を実装する必要があります。

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    protected org.slf4j.Logger
    log

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    AbstractRequestControlDirContextProcessor()

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    abstract ControlSE
    createRequestControl()
    適切な RequestControl のインスタンスを作成します。
    boolean
    isReplaceSameControlEnabled()
    コンテキスト内で createRequestControl() によって作成されたものと同じクラスのリクエストコントロールがすでに存在する場合、新しいコントロールは既存のものを置き換えるか (デフォルトの動作)、追加することができます。
    void
    preProcess(DirContextSE ctx)
    LdapContext から既存の RequestControls を取得し、createRequestControl() を呼び出して新しいインスタンスを取得し、コントロールの新しい配列を構築して LdapContext に設定します。
    void
    setReplaceSameControlEnabled(boolean replaceSameControlEnabled)
    コンテキスト内で createRequestControl() によって作成されたものと同じクラスのリクエストコントロールがすでに存在する場合、新しいコントロールは既存のものを置き換えるか (デフォルトの動作)、追加することができます。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

    インターフェース org.springframework.ldap.core.DirContextProcessor から継承されたメソッド

    postProcess

  • フィールドの詳細

    • log

      protected org.slf4j.Logger log

  • コンストラクターの詳細

    • AbstractRequestControlDirContextProcessor

      public AbstractRequestControlDirContextProcessor()

  • メソッドの詳細

    • isReplaceSameControlEnabled

      public boolean isReplaceSameControlEnabled()
      コンテキスト内で createRequestControl() によって作成されたものと同じクラスのリクエストコントロールがすでに存在する場合、新しいコントロールは既存のものを置き換えるか (デフォルトの動作)、追加することができます。
      戻り値:
      既存のコントロールが置き換えられる場合は true

    • setReplaceSameControlEnabled

      public void setReplaceSameControlEnabled(boolean replaceSameControlEnabled)
      コンテキスト内で createRequestControl() によって作成されたものと同じクラスのリクエストコントロールがすでに存在する場合、新しいコントロールは既存のものを置き換えるか (デフォルトの動作)、追加することができます。
      パラメーター:
      replaceSameControlEnabled - 既存のコントロールを置き換える必要がある場合は true 

    • preProcess

      public void preProcess(DirContextSE ctx) throws NamingExceptionSE
      LdapContext から既存の RequestControls を取得し、createRequestControl() を呼び出して新しいインスタンスを取得し、コントロールの新しい配列を構築して LdapContext に設定します。

      ControlSE 機能は LDAP v3 に固有であるため、LdapContextSE にのみ適用されます。ただし、preProcess および postProcess の呼び出しに使用される汎用 DirContextProcessor メカニズムは、LDAP v2 でも機能するため、DirContext を使用します。これが、DirContext を LdapContext にキャストする必要がある理由です。

      次で指定:
      インターフェース DirContextProcessor の preProcess 
      パラメーター:
      ctx - LdapContext インスタンス。
      例外:
      NamingExceptionSE
      IllegalArgumentExceptionSE - 提供された DirContext が LdapContext でない場合。

    • createRequestControl

      public abstract ControlSE createRequestControl()
      適切な RequestControl のインスタンスを作成します。
      戻り値:
      新しいインスタンス。