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 の可能性があるバイト配列。