モジュール java.naming
パッケージ javax.naming.ldap

インタフェースControl

  • すべてのスーパー・インタフェース:
    Serializable
    既知のすべての実装クラス:
    BasicControl, ManageReferralControl, PagedResultsControl, PagedResultsResponseControl, SortControl, SortResponseControl
    public interface Control
extends Serializable
    このインタフェースは、RFC 2251で定義されたLDAPv3コントロールを表します。

    LDAPv3プロトコルは、コントロールを使用して追加データの送受信を行い事前定義された操作の動作に影響を与えます。 コントロールは、LDAP操作と一緒にサーバーに送信することが可能です。 このようなコントロールを要求コントロールといいます。 たとえば、ソート・コントロールの場合、指定した順序で結果を返すように要求するLDAPの検索操作のときに送信できます。 要請および非要請コントロールの場合も、サーバーの応答を返すことができます。 このようなコントロールを応答コントロールといいます。 たとえばLDAPサーバーでは、変更通知を返す特別なコントロールを定義できます。

    このインタフェースは、要求コントロールおよび応答コントロールを表示するのに使用されます。

    導入されたバージョン:
    1.3
    関連項目:
    ControlFactory

    • フィールドのサマリー

      フィールド 
      修飾子と型 フィールド 説明
      static boolean CRITICAL
      クリティカル・コントロールを示します。
      static boolean NONCRITICAL
      非クリティカル・コントロールを示します。

    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 抽象メソッド 
      修飾子と型 メソッド 説明
      byte[] getEncodedValue()
      LDAPコントロールのASN.1 BERでエンコードされた値を取得します。
      String getID()
      LDAPコントロールに割り当てられたオブジェクト識別子を取得します。
      boolean isCritical()
      LDAPコントロールのクリティカルの程度を判定します。

    • フィールドの詳細

      • CRITICAL

        static final boolean CRITICAL
        クリティカル・コントロールを示します。 この定数の値はtrueです。
        関連項目:
        定数フィールド値

      • NONCRITICAL

        static final boolean NONCRITICAL
        非クリティカル・コントロールを示します。 この定数の値はfalseです。
        関連項目:
        定数フィールド値

    • メソッドの詳細

      • getID

        String getID()
        LDAPコントロールに割り当てられたオブジェクト識別子を取得します。
        戻り値:
        null以外のオブジェクト識別子の文字列。

      • isCritical

        boolean isCritical()
        LDAPコントロールのクリティカルの程度を判定します。 クリティカル・コントロールであれば、サーバーは無視できません。 つまり、サーバーがサポートしていないクリティカル・コントロールを受け取ると、コントロールが操作にとって重要であるかどうかにかかわらず、操作は実行されずに、OperationNotSupportedExceptionがスローされます。
        戻り値:
        このコントロールがクリティカルの場合はtrue、そうでない場合はfalse。

      • getEncodedValue

        byte[] getEncodedValue()
        LDAPコントロールのASN.1 BERでエンコードされた値を取得します。 この結果は、コントロール値のタグおよび長さを含むそのまま(raw)のBERバイトで表示されます。 ただし、コントロールのOIDまたはクリティカルの程度については表示されません。 値が空の場合、nullが返されます。
        戻り値:
        LDAPコントロールのASN.1 BERでエンコードされた値を示すnullの可能性があるバイト配列。