javax.naming.ldap
インタフェース Control

すべてのスーパーインタフェース:

Serializable

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

public static final boolean CRITICAL

クリティカルコントロールを示します。この定数の値は true です。

NONCRITICAL

public static final boolean NONCRITICAL

非クリティカルコントロールを示します。この定数の値は false です。

メソッドの詳細

getID

public String getID()

LDAP コントロールに指定されたオブジェクト識別子を検出します。

戻り値:

null 以外のオブジェクト識別子の文字列

isCritical

public boolean isCritical()

LDAP コントロールのクリティカルコントロールを判別します。クリティカルコントロールであれば、サーバは無視できません。つまり、サーバがサポートしていないクリティカルコントロールを受け取ると、コントロールが操作にとって重要であるかどうかに関わらず、操作は実行されずに、OperationNotSupportedException がスローされます。

戻り値:

このコントロールがクリティカルの場合は true、そうでない場合は false

getEncodedValue

public byte[] getEncodedValue()

LDAP コントロールの ASN.1 BER で符号化された値を検出します。この結果は、コントロール値のタグおよび長さを含むそのまま (raw) の BER バイトで表示されます。ただし、コントロールの OID またはクリティカルの程度については表示されません。 値が空の場合、null が返されます。

戻り値:

LDAP コントロールの ASN.1 BER で符号化された値を示す null の可能性があるバイト配列